Skip to content
<open-source>
Oeiuwq Faith Blog OpenSource Porfolio

AEduardo-dev/flk

Flakes development environments management tool
Source code at GitHub null
AEduardo-dev/flk.json
{
  "createdAt": "2025-10-24T09:55:00Z",
  "defaultBranch": "main",
  "description": "Flakes development environments management tool",
  "fullName": "AEduardo-dev/flk",
  "homepage": null,
  "language": "Rust",
  "name": "flk",
  "pushedAt": "2025-11-20T08:57:17Z",
  "stargazersCount": 6,
  "topics": [],
  "updatedAt": "2025-11-23T12:20:40Z",
  "url": "https://github.com/AEduardo-dev/flk"
}

flk 🚀

Section titled “flk 🚀”

A modern CLI tool for managing Nix flake development environments with the simplicity of Devbox

Crates.io License: MIT Rust

flk makes managing Nix flakes feel like using a package manager. No more manually editing flake.nix files—just use simple commands to add packages, create custom shell commands, and manage your development environment.

✨ Features

Section titled “✨ Features”
  • 🎯 Smart Initialization - Auto-detects your project type (Rust, Python, Node.js, Go) and creates the right template
  • 🔍 Package Search - Search nixpkgs directly from your terminal
  • 📦 Easy Package Management - Add and remove packages with simple commands
  • ⚡ Custom Shell Commands - Define reusable commands for your development workflow
  • 🌍 Environment Variables - Manage environment variables through the CLI
  • 🔒 Lock File Management - View, backup, and restore your flake.lock with ease
  • 🎨 Language Templates - Pre-configured templates for popular languages and frameworks

📦 Installation

Section titled “📦 Installation”

Prerequisites

Section titled “Prerequisites”
  • Nix with flakes enabled
  • Rust 1.83+ (if building from source)

From Source

Section titled “From Source”
Terminal window
git clone https://github.com/AEduardo-dev/flk.git
cd flk
cargo build --release
sudo cp target/release/flk /usr/local/bin/

From Cargo (Coming Soon)

Section titled “From Cargo (Coming Soon)”
Terminal window
cargo install flk

With Nix

Section titled “With Nix”
Terminal window
nix profil install github:AEduardo-dev/flk

🚀 Quick Start

Section titled “🚀 Quick Start”

1. Initialize Your Project

Section titled “1. Initialize Your Project”
Terminal window
# Auto-detect project type and create flake.nix
flk init


# Or specify a template
flk init --template rust
flk init --template python
flk init --template node
flk init --template go

Supported auto-detection:

  • Cargo.toml → Rust template
  • package.json → Node.js template
  • pyproject.toml or requirements.txt → Python template
  • go.mod → Go template

2. Add Packages

Section titled “2. Add Packages”
Terminal window
# Search for packages
flk search ripgrep


# Get detailed package info
flk deep-search ripgrep --versions


# Add packages to your environment
flk add ripgrep
flk add git
flk add neovim

3. Add Custom Commands

Section titled “3. Add Custom Commands”
Terminal window
# Add inline commands
flk add-command test "cargo test --all"
flk add-command dev "npm run dev"


# Source commands from a file
flk add-command scripts --file ./scripts/dev.sh

4. Manage Environment Variables

Section titled “4. Manage Environment Variables”
Terminal window
# Add environment variables
flk env add DATABASE_URL "postgresql://localhost/mydb"
flk env add API_KEY "your-api-key"


# List all environment variables
flk env list


# Remove an environment variable
flk env remove API_KEY

5. Enter Your Development Environment

Section titled “5. Enter Your Development Environment”
Terminal window
nix develop

Your custom commands and environment variables will be automatically available!

6. Generate completions

Section titled “6. Generate completions”
Terminal window
# Generates the completion file and prints it
flk completions


# Install the generated completions to the detected shell
flk completions --install

Follow the instructions after the command to make the completions available for you.

📖 Command Reference

Section titled “📖 Command Reference”

Project Management

Section titled “Project Management”

flk init [OPTIONS]

Section titled “flk init [OPTIONS]”

Initialize a new flake.nix in the current directory.

Options:

  • -t, --template <TYPE> - Project type: rust, python, node, go, or generic
  • -f, --force - Overwrite existing flake.nix

Examples:

Terminal window
flk init                    # Auto-detect project type
flk init --template rust    # Use Rust template
flk init --force            # Overwrite existing flake.nix

flk activate

Section titled “flk activate”

Activate the nix shell for the current shell session. This command sets up the necessary environment for your project based on the flake.nix configuration. It also installs some convenience features, such as a shell hook to refresh.

flk show

Section titled “flk show”

Display the contents and configuration of your flake.nix in a human-readable format.

Terminal window
flk show

flk list

Section titled “flk list”

List all packages in your development environment.

Terminal window
flk list

Package Management

Section titled “Package Management”

flk search <QUERY> [OPTIONS]

Section titled “flk search <QUERY> [OPTIONS]”

Search for packages in nixpkgs.

Options:

  • -l, --limit <NUMBER> - Limit number of results (default: 10)

Examples:

Terminal window
flk search ripgrep
flk search python --limit 20

flk deep-search <PACKAGE> [OPTIONS]

Section titled “flk deep-search <PACKAGE> [OPTIONS]”

Get detailed information about a specific package.

Options:

  • -v, --versions - Show version pinning information

Examples:

Terminal window
flk deep-search ripgrep
flk deep-search python311 --versions

flk add <PACKAGE>

Section titled “flk add <PACKAGE>”

Add a package to your flake.nix.

Examples:

Terminal window
flk add ripgrep
flk add git
flk add nodejs

Note: Version pinning is planned for a future release (see issue #5).

flk remove <PACKAGE>

Section titled “flk remove <PACKAGE>”

Remove a package from your flake.nix.

Examples:

Terminal window
flk remove ripgrep

Custom Commands

Section titled “Custom Commands”

flk add-command <NAME> <COMMAND> [OPTIONS]

Section titled “flk add-command <NAME> <COMMAND> [OPTIONS]”

Add a custom shell command to your development environment.

Options:

  • -f, --file <PATH> - Source commands from a file

Examples:

Terminal window
# Inline command
flk add-command test "cargo test --all"
flk add-command dev "npm run dev -- --watch"


# Multi-line command
flk add-command deploy "cargo build --release && scp target/release/app server:/opt/"


# Source from file
flk add-command scripts --file ./dev-scripts.sh

Command naming rules:

  • Must contain only letters, numbers, hyphens, and underscores
  • Cannot start with a hyphen
  • Examples: test, dev-server, build_prod

flk remove-command <NAME>

Section titled “flk remove-command <NAME>”

Remove a custom command from your dev shell.

Examples:

Terminal window
flk remove-command test

Environment Variables

Section titled “Environment Variables”

flk env add <NAME> <VALUE>

Section titled “flk env add <NAME> <VALUE>”

Add an environment variable to your dev shell.

Examples:

Terminal window
flk env add DATABASE_URL "postgresql://localhost:5432/mydb"
flk env add NODE_ENV "development"
flk env add API_KEY "sk-..."

Variable naming rules:

  • Must start with a letter or underscore
  • Can only contain letters, numbers, and underscores
  • Examples: MY_VAR, _private, API_KEY_2

flk env remove <NAME>

Section titled “flk env remove <NAME>”

Remove an environment variable from your dev shell.

Examples:

Terminal window
flk env remove DATABASE_URL

flk env list

Section titled “flk env list”

List all environment variables in your dev shell.

Terminal window
flk env list

Lock File Management

Section titled “Lock File Management”

flk lock show

Section titled “flk lock show”

Display detailed information about your flake.lock file.

Terminal window
flk lock show

flk lock history

Section titled “flk lock history”

Show backup history of your lock file.

Terminal window
flk lock history

flk lock restore <BACKUP>

Section titled “flk lock restore <BACKUP>”

Restore a previous version of your lock file.

Examples:

Terminal window
flk lock restore latest                    # Restore most recent backup
flk lock restore 2025-01-27_14-30-00      # Restore specific backup

Updates

Section titled “Updates”

flk update [OPTIONS]

Section titled “flk update [OPTIONS]”

Update all flake inputs to their latest versions.

Options:

  • --show - Preview updates without applying them

Examples:

Terminal window
flk update              # Update all inputs
flk update --show       # Preview available updates

Note: A backup of your flake.lock is automatically created before updating.

Exports

Section titled “Exports”

flk export --format <FORMAT> [OPTIONS]

Section titled “flk export --format <FORMAT> [OPTIONS]”

Export the current flake configuration to different formats. Options:

  • --format <FORMAT> - Export format: docker, podman, json

Examples:

Terminal window
flk export --format docker     # Export as Dockerfile
flk export --format podman     # Export as Podmanfile
flk export --format json       # Export as JSON

💡 Usage Examples

Section titled “💡 Usage Examples”

Python Data Science Environment

Section titled “Python Data Science Environment”
Terminal window
flk init --template python
flk add python311Packages.numpy
flk add python311Packages.pandas
flk add python311Packages.matplotlib
flk add jupyter


flk add-command notebook "jupyter notebook --port=8888"
flk env add JUPYTER_CONFIG_DIR "./.jupyter"


nix develop
notebook  # Your custom command is ready!

Rust Web Development

Section titled “Rust Web Development”
Terminal window
flk init --template rust
flk add postgresql
flk add redis


flk add-command dev "cargo watch -x run"
flk add-command migrate "sqlx migrate run"
flk env add DATABASE_URL "postgresql://localhost/myapp"


nix develop
dev      # Start development server with auto-reload
migrate  # Run database migrations

Node.js Full-Stack Project

Section titled “Node.js Full-Stack Project”
Terminal window
flk init --template node
flk add postgresql
flk add docker-compose


flk add-command dev "npm run dev"
flk add-command db "docker-compose up -d postgres"
flk env add NODE_ENV "development"


nix develop
db   # Start database
dev  # Start development server

Go Microservice

Section titled “Go Microservice”
Terminal window
flk init --template go
flk add protobuf
flk add grpcurl


flk add-command build "go build -o bin/service ./cmd/service"
flk add-command proto "protoc --go_out=. --go-grpc_out=. api/*.proto"
flk env add GO_ENV "development"


nix develop
proto  # Generate protobuf code
build  # Build the service

🛠️ Development

Section titled “🛠️ Development”

Prerequisites

Section titled “Prerequisites”
  • Rust 1.70+
  • Nix with flakes enabled

Building

Section titled “Building”
Terminal window
git clone https://github.com/AEduardo-dev/flk.git
cd flk
cargo build

Running Tests

Section titled “Running Tests”
Terminal window
# Run all tests
cargo test


# Run integration tests
cargo test --test integration_tests


# Run with output
cargo test -- --nocapture

Installing Locally

Section titled “Installing Locally”
Terminal window
cargo install --path .

🏗️ Project Structure

Section titled “🏗️ Project Structure”
flk/
├── src/
│   ├── main.rs               # CLI entry point
│   ├── commands/             # Command implementations
│   │   ├── activate.rs       # Activate dev shell
│   │   ├── add.rs            # Add packages
│   │   ├── add_command.rs    # Add custom commands
│   │   ├── completions.rs    # Shell completions
│   │   ├── env.rs            # Environment variable management
│   │   ├── export.rs         # Export flake config
│   │   ├── init.rs           # Initialize flake
│   │   ├── list.rs           # List packages
│   │   ├── lock.rs           # Lock file management
│   │   ├── mod.rs
│   │   ├── remove.rs         # Remove packages
│   │   ├── remove_command.rs # Remove custom commands
│   │   ├── search.rs         # Search packages
│   │   ├── show.rs           # Display flake config
│   │   └── update.rs         # Update flake inputs
│   ├── flake/                # Flake parsing and generation
│   │   ├── generator.rs      # Generate flake.nix
│   │   ├── interface.rs      # Data structures
│   │   ├── mod.rs
│   │   └── parser.rs         # Parse flake.nix
│   ├── nix/                  # Nix command wrappers
│   │   └── mod.rs
│   └── utils/                # Utility functions
│       ├── backup.rs         # Backup management
│       ├── mod.rs
│       └── visual.rs         # Visual enhancements
├── templates/                # Flake templates
│   ├── default_flake.nix
│   ├── rust_flake.nix
│   ├── python_flake.nix
│   ├── node_flake.nix
│   └── go_flake.nix
└── tests/                    # Test files
    ├── integration_tests.rs
    └── unit_tests.rs

🗺️ Roadmap

Section titled “🗺️ Roadmap”

Roadmap

🤝 Contributing

Section titled “🤝 Contributing”

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

How to Contribute

Section titled “How to Contribute”
  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

🐛 Bug Reports

Section titled “🐛 Bug Reports”

If you find a bug, please open an issue with:

  • A clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Your environment (OS, Nix version, etc.)

🔗 Related Projects

Section titled “🔗 Related Projects”
  • Devbox - Instant, portable dev environments (inspiration for flk)
  • devenv - Fast, declarative developer environments
  • Flox - Developer environments you can take with you
  • direnv - Shell extension for loading environments

📄 License

Section titled “📄 License”

This project is licensed under the MIT License - see the [LICENSE]!(LICENSE) file for details.

🙏 Acknowledgments

Section titled “🙏 Acknowledgments”
  • The Nix community for creating an amazing ecosystem
  • Jetify for the Devbox inspiration and showing what’s possible
  • All contributors and users of flk

📞 Support

Section titled “📞 Support”
  • 📧 Open an issue for bug reports or feature requests
  • 💬 Start a discussion for questions or ideas
  • ⭐ Star the repository if you find it useful!

Made with ❤️ by AEduardo-dev

Note: This project is under active development (v0.1.0). While all core features are implemented and working, some advanced features like version pinning are still in progress. See the [roadmap]!(#-roadmap) for details.