@oclif/plugin-autocomplete
Version:
autocomplete plugin for oclif
70 lines (43 loc) • 2.14 kB
Markdown
# @oclif/plugin-autocomplete
autocomplete plugin for oclif (bash, zsh and powershell)
[](https://npmjs.org/package/@oclif/plugin-autocomplete)
[](https://npmjs.org/package/@oclif/plugin-autocomplete)
[](https://github.com/oclif/plugin-autocomplete/blob/main/package.json)
<!-- toc -->
* [@oclif/plugin-autocomplete](#oclifplugin-autocomplete)
* [Usage](#usage)
* [Commands](#commands)
* [Contributing](#contributing)
<!-- tocstop -->
# Usage
Run `<cli> autocomplete` to generate the autocomplete files for your current shell.
## Topic separator
Since oclif v2 it's possible to use spaces as a topic separator in addition to colons.
For bash and zsh each topic separator has different autocomplete implementations, if the CLI supports using a space as the separator, plugin-autocomplete will generate completion for that topic.
If you still want to use the colon-separated autocomplete you can set `OCLIF_AUTOCOMPLETE_TOPIC_SEPARATOR` to `colon` and re-generate the autocomplete files.
Docs: https://oclif.io/docs/topic_separator
# Commands
<!-- commands -->
* [`oclif-example autocomplete [SHELL]`](#oclif-example-autocomplete-shell)
## `oclif-example autocomplete [SHELL]`
Display autocomplete installation instructions.
```
USAGE
$ oclif-example autocomplete [SHELL] [-r]
ARGUMENTS
SHELL (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ oclif-example autocomplete
$ oclif-example autocomplete bash
$ oclif-example autocomplete zsh
$ oclif-example autocomplete powershell
$ oclif-example autocomplete --refresh-cache
```
_See code: [src/commands/autocomplete/index.ts](https://github.com/oclif/plugin-autocomplete/blob/v3.2.7/src/commands/autocomplete/index.ts)_
<!-- commandsstop -->
# Contributing
See [contributing guide](./CONRTIBUTING.md)