Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mlvzk/manix
A fast CLI documentation searcher for Nix.
https://github.com/mlvzk/manix
Last synced: 2 months ago
JSON representation
A fast CLI documentation searcher for Nix.
- Host: GitHub
- URL: https://github.com/mlvzk/manix
- Owner: mlvzk
- License: mpl-2.0
- Created: 2020-08-15T17:14:06.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-28T15:07:18.000Z (12 months ago)
- Last Synced: 2024-08-02T13:34:19.768Z (6 months ago)
- Language: Rust
- Size: 508 KB
- Stars: 343
- Watchers: 15
- Forks: 19
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nix - manix - Find configuration options and function documentation for Nixpkgs, NixOS, and Home Manager. (Command-Line Tools / Discovery)
README
# Manix
A fast CLI documentation searcher for Nix.
## Supported sources:
- Nixpkgs Documentation
- Nixpkgs Comments
- Nixpkgs Tree (pkgs., pkgs.lib.)
- NixOS 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/mlvzk/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/mlvzk/manix/archive/master.tar.gz
```
### Nix with flakes enabled
``` sh
$ nix run 'github:mlvzk/manix' mapAttrs
```
## Kudos
The inspiration for this project came from [nix-doc](https://github.com/lf-/nix-doc)