Home

Awesome

sfdx-plugin-autocmplt

autocomplete plugin for sfdx (bash & zsh & fish)
based on oclif/plugin-autocomplete, heroku/heroku-cli-autocomplete

sfdx Version test-and-release Downloads/week License

Install

sfdx plugins:install sfdx-autocmplt

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

sfdx autocmplt [SHELL]

display autocomplete installation instructions

USAGE
  $ sfdx autocmplt [SHELL] [--flags-dir <value>] [-r]

ARGUMENTS
  SHELL  shell type

FLAGS
  -r, --refresh-cache  refresh cache only (ignores displaying instructions)

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  display autocomplete installation instructions

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

sfdx autocomplete create

create autocomplete setup scripts and completion functions

USAGE
  $ sfdx autocomplete create [--flags-dir <value>]

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  create autocomplete setup scripts and completion functions

ALIASES
  $ sfdx autocomplete create

sfdx autocomplete doctor [SHELL]

autocomplete diagnostic

USAGE
  $ sfdx autocomplete doctor [SHELL] [--flags-dir <value>] [--debug]

ARGUMENTS
  SHELL  shell type

FLAGS
  --debug  list completable commands

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  autocomplete diagnostic

ALIASES
  $ sfdx autocomplete doctor

sfdx autocomplete options [COMPLETION]

display arg or flag completion options (used internally by completion fuctions)

USAGE
  $ sfdx autocomplete options [COMPLETION] [--flags-dir <value>]

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  display arg or flag completion options (used internally by completion fuctions)

ALIASES
  $ sfdx autocomplete options

sfdx autocomplete script SHELL

display autocomplete setup script for shell

USAGE
  $ sfdx autocomplete script SHELL [--flags-dir <value>]

ARGUMENTS
  SHELL  shell type

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  display autocomplete setup script for shell

ALIASES
  $ sfdx autocomplete script
<!-- commandsstop -->