Code View

plugin / plugin-2.2.0.0 / tools / auto-complete / README.md
Preview
# plugin — Shell auto-completion

Tab-completion for the DSO signing CLI tools shipped in this package:
`dso-keygen`, `dso-sign`, `dso-verify`.

| File | Shell | Tool |
|---|---|---|
| `dso-keygen.bash` | Bash | `dso-keygen` |
| `_dso-keygen`     | Zsh  | `dso-keygen` |
| `dso-sign.bash`   | Bash | `dso-sign`   |
| `_dso-sign`       | Zsh  | `dso-sign`   |
| `dso-verify.bash` | Bash | `dso-verify` |
| `_dso-verify`     | Zsh  | `dso-verify` |

These lived under `ffs/tools/auto-complete/` until the Conan migration moved
the tools themselves out of FFS and into this package. The completion sources
now travel with the tools they describe — keep the three artefacts (the
tool's `--help`, the `*.bash` file and the `_*` file) in sync on any change
to a command interface.

## Install

`cmake --install` (and every CPack archive) places these where the shells
look for them automatically:

- Bash → `<prefix>/share/bash-completion/completions/dso-{keygen,sign,verify}`
- Zsh  → `<prefix>/share/zsh/site-functions/_dso-{keygen,sign,verify}`

For a checkout without an install, source them directly:

```bash
# Bash — current shell
for f in tools/auto-complete/*.bash; do source "$f"; done

# Zsh — add the directory to fpath before compinit
fpath=("$PWD/tools/auto-complete" $fpath)
autoload -Uz compinit && compinit
```