Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmajid2301/optinix
A CLI tool written in go, for searching options in Nix. Mirrored from https://gitlab.com/hmajid2301/optinix
https://github.com/hmajid2301/optinix
cli go nix nixos
Last synced: 3 months ago
JSON representation
A CLI tool written in go, for searching options in Nix. Mirrored from https://gitlab.com/hmajid2301/optinix
- Host: GitHub
- URL: https://github.com/hmajid2301/optinix
- Owner: hmajid2301
- License: mit
- Created: 2023-10-12T23:02:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-22T22:43:27.000Z (3 months ago)
- Last Synced: 2024-11-22T23:24:52.187Z (3 months ago)
- Topics: cli, go, nix, nixos
- Language: Go
- Homepage:
- Size: 4.6 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# OptiNix
- [OptiNix](#optinix)
- [Demo](#demo)
- [TUI](#tui)
- [No TUI - FZF](#no-tui-fzf)
- [Install](#install)
- [Nix flakes](#nix-flakes)
- [Go](#go)
- [Nix](#nix)
- [Usage](#usage)
- [Nix with flakes](#nix-with-flakes)
- [Key Maps](#key-maps)
- [Without TUI](#without-tui)
- [With FZF](#with-fzf)
- [Update](#update)
- [Supported Sources](#supported-sources)
- [Features to implement](#features-to-implement)
- [Inspired By](#inspired-by)
A CLI tool for searching options in Nix, written in Go, powered by the bubbletea framework for TUI.
## Demo
### TUI
### No TUI - FZF
## Install
There are several ways you can install OptiNix.
### Nix flakes
Add OptiNix as an input to your flake, in your `flake.nix` file
```nix
{
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
flake-utils.url = "github:numtide/flake-utils";
optinix.url = "gitlab:hmajid2301/optinix";
};
outputs = {};
}
```
Then you can install the package in your nix config like in a `devShell`
```nix
{
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
flake-utils.url = "github:numtide/flake-utils";
optinix.url = "gitlab:hmajid2301/optinix";
};
outputs = {
self,
nixpkgs,
flake-utils,
optinix,
...
}: (
flake-utils.lib.eachDefaultSystem
(system: let
pkgs = nixpkgs.legacyPackages.${system};
in {
devShells.default = pkgs.mkShell {
packages = with pkgs; [
optinix.packages.${system}.default
];
};
})
);
}
```
### Go
You can install using `go`
```bash
go install gitlab.com/hmajid2301/optinix
```
### Nix
You can install this package from nixpkgs, like you would with other packages.
```bash
nix-shell -p optinix
optinix --help
```
## Usage
```bash
OptiNix is tool you can use on the command line to search options for NixOS, home-manager and Darwin.
Usage:
optinix [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
get Finds options
help Help about any command
update When you want to fetch the latest options.
Flags:
-h, --help help for optinix
-v, --version version for optinix
Use "optinix [command] --help" for more information about a comman
```
### Nix with flakes
If you are running Nix and have flakes enabled in your configuration, you can run the tool like the command below. Without needing to "install" OptiNix.
```bash
nix run 'gitlab:hmajid2301/optinix' get hyprland
```
### Key Maps
- `j`: Down one item in list
- `k`: Up one item in list
- `t`: Toggle modal, to view more information about the option
- `g`: Top of list
- `G`: End of list
### Without TUI
By default, the tool will render a list using bubble tea, if you want just plain text output you can add the `--no-tui` flag.
```bash
optinix get podman --no-tui
Option: 0
Name: virtualisation.podman.networkSocket.server
Type: value "ghostunnel" (singular enum)
Default:
Example: "ghostunnel"
From: NixOS
Sources: [/nix/store/rhg90jpryc286xn9xjy6qjiaap6pjgdc-source/nixos/modules/virtualisation/podman/network-socket-ghostunnel.nix /nix/store/rhg90jpryc286xn9xjy6qjiaap6pjgdc-source/nixos/modules/virtualisation/podman/network-socket.nix]
Option: 1
Name: virtualisation.podman.networkSocket.enable
Type: boolean
Default: false
Example:
From: NixOS
Sources: [/nix/store/rhg90jpryc286xn9xjy6qjiaap6pjgdc-source/nixos/modules/virtualisation/podman/network-socket.nix]
Option: 2
Name: virtualisation.podman.enable
Type: boolean
Default: false
Example:
From: NixOS
Sources: [/nix/store/rhg90jpryc286xn9xjy6qjiaap6pjgdc-source/nixos/modules/virtualisation/podman/default.nix]
# ...
```
### With FZF
You can integrate this tool with FZF as well, like so:
```bash
optinix get --no-tui | rg "Name: " | cut -d' ' -f2 | fzf --preview="optinix get --no-tui '{}'"
```
### Update
To get the latest options you can run the following command, to update your local database.
```bash
optinix update
```
## Supported Sources
- NixOS
- Home Manager
- Darwin
## Features to implement
- Add more sources (like manix has)
- Maybe nixvim even
- Get it working in Docker
## Inspired By
- Manix: https://github.com/nix-community/manix
- When I started this project back last year, this project was not working but has since been fixed and had new features added