Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nix-community/nix-zsh-completions
ZSH Completions for Nix
https://github.com/nix-community/nix-zsh-completions
Last synced: 3 months ago
JSON representation
ZSH Completions for Nix
- Host: GitHub
- URL: https://github.com/nix-community/nix-zsh-completions
- Owner: nix-community
- License: bsd-3-clause
- Created: 2015-02-11T16:56:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-03-16T20:53:19.000Z (8 months ago)
- Last Synced: 2024-04-15T11:59:42.027Z (7 months ago)
- Language: Shell
- Size: 189 KB
- Stars: 213
- Watchers: 10
- Forks: 28
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ZSH Completions for Nix and NixOS
=================================
This project aims to provide a highly complete set of ZSH completions for [Nix](https://nixos.org/nix/),
[NixOS](https://nixos.org/), [NixOps](http://nixos.org/nixops/), and the surrounding ecosystem.
NixOS
----------------------
Setting `programs.zsh.enable = true` in `/etc/nixos/configuration.nix` will automatically install and enable `nix-zsh-compeletions`.
Oh-My-ZSH Installation
----------------------
```zsh
cd ~/.oh-my-zsh/custom/plugins
git clone [email protected]:nix-community/nix-zsh-completions.git
```
Then add `nix-zsh-completions` to the plugins list in `~/.zshrc`
If you want your prompt to be prefixed by `[nix-shell]` when you're in a nix-shell add this to your zshrc:
```
prompt_nix_shell_setup
```
Antigen Installation
--------------------
Add the following to `~/.zshrc`
```zsh
antigen bundle [email protected]:nix-community/nix-zsh-completions.git
```
Plain ZSH Installation
----------------------
Clone this repository and add the following to `~/.zshrc` with the path to
`nix-zsh-completions` updated as necessary.
```zsh
source $HOME/nix-zsh-completions/nix-zsh-completions.plugin.zsh
fpath=($HOME/nix-zsh-completions $fpath)
autoload -U compinit && compinit
```
Required ZSH version
------------------------
The completion scripts are known to be broken in ZSH version `5.0.8` or older, `5.2` or newer works.
ZSH Completions Tutorial
------------------------
[zsh-completions-howto](https://github.com/zsh-users/zsh-completions/blob/master/zsh-completions-howto.org)