https://github.com/thesola10/zsh-comma-assistant

Supercharge your zsh with the true power of Nix!
https://github.com/thesola10/zsh-comma-assistant

Last synced: 11 days ago
JSON representation

Supercharge your zsh with the true power of Nix!

• Host: GitHub
• URL: https://github.com/thesola10/zsh-comma-assistant
• Owner: Thesola10
• Created: 2022-02-14T12:37:34.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-08T11:18:09.000Z (7 months ago)
• Last Synced: 2024-10-10T19:13:16.173Z (28 days ago)
• Language: Shell
• Size: 52.7 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# zsh-comma-assistant

Tighter integration around the [`comma`](https://github.com/nix-community/comma) utility, so you'll (almost) never get a "command not found" error ever again!

This plugin consists of two parts: a **command not found handler**, and a **syntax highlight addon**.

_See it in action!_

[![on asciinema](https://raw.githubusercontent.com/thesola10/comma-assistant.zsh/master/demo.svg)](https://asciinema.org/a/469027)

## Dependencies

This plugin requires [`nix-index`](https://github.com/bennofs/nix-index) to be installed and available in `PATH`, as well as for the `nix-index` database to have already been built.

It also requires [`comma`](https://github.com/nix-community/comma) (duh) to be installed in `PATH`.

### Syntax highlight

The syntax highlight addon included in this plugin requires [`zsh-syntax-highlighting`](https://github.com/zsh-users/zsh-syntax-highlighting).

The highlight addon can be enabled by adding it to the active highlighters:

```zsh

ZSH_HIGHLIGHT_HIGHLIGHTERS=(main comma)

```

## Configuration

Currently, the following environment variables can be configured to control the behavior of this plugin:

- `$COMMA_INDEX_PATH` is the path to the database directory for `nix-index`. _(default: `$XDG_CACHE_HOME/nix-index`)_

- `$COMMA_INDEX_LIST_PATH` is the path where the plugin should store its auto-generated available commands list. _(default: `$COMMA_INDEX_PATH/cmds`)_

- `${ZSH_HIGHLIGHT_STYLES[comma:cmd]}` is the style to use to highlight a command available in Nix. _(default: `fg=blue`)_