@hackmd/oclif-plugin-autocomplete

2.1.9-fish • Public • Published

@oclif/plugin-autocomplete

autocomplete plugin for oclif (bash & zsh)

Version Downloads/week License

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

oclif-example autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ oclif-example autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  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 fish

  $ oclif-example autocomplete zsh

  $ oclif-example autocomplete --refresh-cache

See code: src/commands/autocomplete/index.ts

Readme

Keywords

Package Sidebar

Install

npm i @hackmd/oclif-plugin-autocomplete

Weekly Downloads

3

Version

2.1.9-fish

License

MIT

Unpacked Size

46.3 kB

Total Files

20

Last publish

Collaborators

  • a60814billy
  • yukaii
  • jackycute