nix-foundry

command module

v1.1.4 Latest Latest Go to latest Published: Jun 6, 2025 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/shawnkhoffman/nix-foundry

Links

Open Source Insights

README ¶

Nix Foundry

Take your development environment anywhere with this simple YAML-based configuration manager. Nix Foundry manages extensible configurations at user, team, and project levels, ensuring consistent and reproducible development environments across platforms.

Overview

Nix Foundry simplifies development environment management:

🚀 Simple YAML configurations that work everywhere
📦 Extensible environment definitions in pure YAML
🔧 User, team, and project-specific settings
🌟 Consistent development environments
🛠️ Cross-platform compatibility

Quick Start

# Install Nix Foundry
nix-foundry install

# Install packages
nix-foundry config set package add nodejs

# View configuration
cat ~/.config/nix-foundry/config.yaml # Woah, my config is portable!

# Apply configuration
nix-foundry apply

# Then, start a new terminal and see your environment!

Features

Simple Configuration: Pure YAML-based environment definitions
Portable Environments: Take your development setup anywhere
Multi-Level Configs: User, team, and project configurations
Extensible System: Build on existing configurations
Cross-Platform: Linux, macOS, and Windows (WSL2)

Documentation

Platform Support

Linux: Most major distributions
macOS: Intel and Apple Silicon
Windows: WSL2

Example Configuration

version: 'v1'
kind: 'NixConfig'
type: 'project'
metadata:
  name: 'web-dev'
  description: 'Web development environment'
settings:
  shell: 'zsh'
  autoUpdate: true
nix:
  packages:
    core:
      - git
      - nodejs
    optional:
      - postgresql
      - redis

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Documentation ¶

Overview ¶

Package main provides the entry point for the Nix Foundry CLI application.

Source Files ¶

View all Source files

main.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cmd Package cmd provides the command-line interface for Nix Foundry.	Package cmd provides the command-line interface for Nix Foundry.
config Package config provides configuration management commands for Nix Foundry.	Package config provides configuration management commands for Nix Foundry.
config/set Package set provides commands for setting various configuration options in Nix Foundry.	Package set provides commands for setting various configuration options in Nix Foundry.
pkg
config Package config provides configuration management functionality for Nix Foundry.	Package config provides configuration management functionality for Nix Foundry.
docs Package docs provides documentation generation functionality for Nix Foundry.	Package docs provides documentation generation functionality for Nix Foundry.
filesystem Package filesystem provides filesystem abstraction for Nix Foundry.	Package filesystem provides filesystem abstraction for Nix Foundry.
nix Package nix provides Nix package manager installation functionality.	Package nix provides Nix package manager installation functionality.
packages Package packages provides package management functionality for Nix Foundry.	Package packages provides package management functionality for Nix Foundry.
platform Package platform provides platform-specific functionality and detection for different operating systems.	Package platform provides platform-specific functionality and detection for different operating systems.
schema Package schema provides configuration schema definitions for Nix Foundry.	Package schema provides configuration schema definitions for Nix Foundry.
script Package script provides functionality for managing shell scripts.	Package script provides functionality for managing shell scripts.
shell Package shell provides functionality for managing shell configurations across different platforms and shell types.	Package shell provides functionality for managing shell configurations across different platforms and shell types.
tui Package tui provides terminal user interface components for Nix Foundry.	Package tui provides terminal user interface components for Nix Foundry.
validator Package validator provides configuration validation functionality for Nix Foundry.	Package validator provides configuration validation functionality for Nix Foundry.
scripts Package main provides documentation generation functionality.	Package main provides documentation generation functionality.
service
config Package config provides configuration management functionality.	Package config provides configuration management functionality.