https://github.com/Aloxaf/gencomp

Generate zsh completion functions from manpage or `--help`
https://github.com/Aloxaf/gencomp

Last synced: about 2 months ago
JSON representation

Generate zsh completion functions from manpage or `--help`

• Host: GitHub
• URL: https://github.com/Aloxaf/gencomp
• Owner: Aloxaf
• License: mit
• Created: 2020-03-16T04:36:56.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-03-18T07:55:29.000Z (over 4 years ago)
• Last Synced: 2024-06-25T23:37:46.267Z (3 months ago)
• Language: Python
• Size: 38.1 KB
• Stars: 10
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gencomp

Generate zsh completion functions from [manpage](https://github.com/nevesnunes/sh-manpage-completions) or [`--help`](https://github.com/RobSis/zsh-completion-generator).

# Install

**Manual**

First, clone this repository

```zsh

git clone https://github.com/Aloxaf/gencomp ~/somewhere

```

Then add the following line to your `~/.zshrc`

```zsh

source ~/somewhere/gencomp.plugin.zsh

```

**Antigen**

```zsh

antigen bundle Aloxaf/gencomp

```

**Zinit**

```zsh

zinit light Aloxaf/gencomp

```

**Oh-My-Zsh**

Clone this repository to your custom directory and then add `gencomp` to your plugin list.

```zsh

git clone https://github.com/Aloxaf/gencomp ~ZSH_CUSTOM/plugins/gencomp

```

# Usage

**From manpage**

```zsh

gencomp fzf --man

gencomp /usr/share/man/man1/rlwrap.1.gz

```

**From `--help`**

```zsh

gencomp bat

```

# Related project

- https://github.com/nevesnunes/sh-manpage-completions

- https://github.com/RobSis/zsh-completion-generator