Skip to content

oclif/plugin-autocomplete

Folders and files

NameName
Last commit message
Last commit date
Oct 23, 2023
Jun 11, 2024
Jul 22, 2024
Jan 29, 2025
Jan 29, 2025
Jan 29, 2025
Oct 23, 2023
May 8, 2018
Apr 9, 2024
Feb 22, 2024
Oct 23, 2023
May 8, 2018
Oct 23, 2023
Feb 23, 2025
Mar 18, 2024
May 8, 2018
Feb 23, 2025
Jan 29, 2025
Feb 24, 2025
Jul 1, 2024
Feb 24, 2025

Repository files navigation

@oclif/plugin-autocomplete

autocomplete plugin for oclif (bash, zsh and powershell)

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  (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

Contributing

See contributing guide