Skip to content

Latest commit

 

History

History
114 lines (70 loc) · 2.8 KB

README.md

File metadata and controls

114 lines (70 loc) · 2.8 KB

flake-store-cli

flake-store-cli

flake-store-cli is an interactive CLI application to browse, search, and install Nix flakes from the flake-store-flakes repository. With a user-friendly TUI powered by Bubble Tea, you can select and install flakes seamlessly into your project directories.

Demo

TUI Demo

Installation

Make sure you have Go installed:

git clone https://github.com/SaladinAyyub/flake-store-cli.git
cd flake-store-cli
go build -o flake-store-cli

Or install using go install:

go install github.com/SaladinAyyub/flake-store-cli@latest

Usage

Launch Interactive TUI (default)

Simply run:

flake-store-cli list

This will launch the interactive TUI to browse and install flakes.

  • Use arrow keys to navigate.
  • Press Enter to install a flake.
  • Press q or Esc to quit.

Commands

Command Description
flake-store-cli list Launch the interactive TUI to browse flakes
flake-store-cli install <flake-name> [--nodirenv] Install flake.nix and optional shell.nix from the specified flake into the current directory. Creates .envrc unless --nodirenv is provided
flake-store-cli search <query> Search flakes by name and display matching flakes
flake-store-cli fetch forces the latest flake.json from master to be cached

Install a Flake via CLI

flake-store-cli install hikari-crescent-python
  • Installs flake.nix and optional shell.nix from the specified flake into the current directory.
  • Creates a .envrc file for direnv automatically unless --nodirenv is specified.

Search Flakes

flake-store-cli search <query>

Search flakes by name and print matching results.

Example:

flake-store-cli search raylib

Contributing

Want to add a new flake? Contributions are welcome!

Please submit flakes as Pull Requests to the flake-store-flakes repository.

Steps:

  1. Fork the flake-store-flakes repository.
  2. Add your flake in a new folder with flake.nix (and optional shell.nix).
  3. Update the description in flake.nix.
  4. Submit a Pull Request.

Once merged, your flake will automatically appear in flake-store-cli.

Supporting

Support me via ko-fi !

Donate and Support

License

GPL V3