Skip to content

Commit

Permalink
README: Add completion documentation
Browse files Browse the repository at this point in the history
Adds documentation on generating bash and zsh completions.
  • Loading branch information
BrainBlasted committed Feb 10, 2019
1 parent 6f2cac7 commit 53a92ab
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,25 @@ Enter default GitLab host (default: https://gitlab.com):
Enter default GitLab user: zaq
Enter default GitLab token:
```
# Completions

`lab` provides completions for bash and zsh.

### Bash

`lab completion bash` will generate a bash completion script. Save this script and source it in your `.bashrc`:

```bash
source "/path/to/lab-completions.bash"
```

### Zsh

`lab completion zsh` will generate a zsh completion script. zsh completions are denoted with the syntax `_command-name`, so save the output of `lab completion` to a file name `_lab`. Place the file in your `$FPATH`, or create an new directory and add it to your `$FPATH`.

```zsh
fpath=(/path/to/script_directory $fpath)
```

# Aliasing

Expand Down

0 comments on commit 53a92ab

Please sign in to comment.