Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nix-community/manix
A fast CLI documentation searcher for Nix [maintainers=@IogaMaster, @bayou-brogrammer]
https://github.com/nix-community/manix
cli home-manager manix nix nixos nixpkgs rust
Last synced: 14 days ago
JSON representation
A fast CLI documentation searcher for Nix [maintainers=@IogaMaster, @bayou-brogrammer]
- Host: GitHub
- URL: https://github.com/nix-community/manix
- Owner: nix-community
- License: apache-2.0
- Fork: true (mlvzk/manix)
- Created: 2023-10-09T16:12:46.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-01T22:38:19.000Z (8 months ago)
- Last Synced: 2025-01-16T21:23:07.184Z (18 days ago)
- Topics: cli, home-manager, manix, nix, nixos, nixpkgs, rust
- Language: Rust
- Homepage:
- Size: 519 KB
- Stars: 84
- Watchers: 4
- Forks: 4
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Manix
A fast CLI documentation searcher for Nix.
## Supported sources
- Nixpkgs Documentation
- Nixpkgs Comments
- Nixpkgs Tree (pkgs, pkgs.lib)
- NixOS Options
- Nix-Darwin Options
- Home-Manager Options
## Usage
```sh
manix --help
manix mergeattr
manix --strict mergeattr
manix --update-cache mergeattr
```
### rnix-lsp
If you want to use it in your editor, check [ElKowar's rnix-lsp fork](https://github.com/elkowar/rnix-lsp), which uses it to provide documentation on hover and autocompletion.
### fzf
```sh
manix "" | grep '^# ' | sed 's/^# \(.*\) (.*/\1/;s/ (.*//;s/^# //' | fzf --preview="manix '{}'" | xargs manix
```
## Installation
### Update
Manix is now available in nixpkgs. If you use the unstable channel installing is as easy as adding `manix` to your `environment.systemPackages` or `home.packages`.
### Github Releases
Since it can take some time to compile Manix, you can download statically-built executables from Github Releases.
```sh
wget https://github.com/nix-community/manix/releases/latest/download/manix
chmod +x manix
mv manix ~/bin/ # or some other location in your $PATH
```
### nix-env
```sh
# If you have the unstable channel on your system
nix-env -f '' -iA manix
# OR
nix-env -i -f https://github.com/nix-community/manix/archive/master.tar.gz
# OR
nix profile install github:nix-community/manix/latest
```
### Nix with flakes enabled
``` sh
nix run 'github:nix-community/manix' mapAttrs
```
## Kudos
The original [manix](https://github.com/mlvzk/manix). mlvzk has been inactive for over a year, we thank him for his hard work.
The inspiration for this project came from [nix-doc](https://github.com/lf-/nix-doc)