https://github.com/jayree/sfdx-autocomplete-plugin
autocomplete plugin for sfdx (bash & zsh & fish) based on oclif/plugin-autocomplete and heroku/heroku-cli-autocomplete
https://github.com/jayree/sfdx-autocomplete-plugin
Last synced: 5 months ago
JSON representation
autocomplete plugin for sfdx (bash & zsh & fish) based on oclif/plugin-autocomplete and heroku/heroku-cli-autocomplete
- Host: GitHub
- URL: https://github.com/jayree/sfdx-autocomplete-plugin
- Owner: jayree
- License: bsd-3-clause
- Created: 2019-01-06T17:38:13.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-06-20T08:14:58.000Z (5 months ago)
- Last Synced: 2025-06-20T23:07:01.074Z (5 months ago)
- Language: TypeScript
- Homepage:
- Size: 3.41 MB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-zsh-plugins - sfdx-autocomplete - Autocomplete plugin for Salesforce [sfdx](https://developer.salesforce.com/tools/salesforcecli). (Completions / ZSH on Windows)
- fucking-awesome-zsh-plugins - sfdx-autocomplete - Autocomplete plugin for Salesforce 🌎 [sfdx](developer.salesforce.com/tools/salesforcecli). (Completions / ZSH on Windows)
- awesome-zsh-plugins - sfdx-autocomplete - autocomplete plugin for sfdx. (Completions / Zinit (née zplugin))
README
# sfdx-plugin-autocmplt
autocomplete plugin for sfdx (bash & zsh & fish)
based on [oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete), [heroku/heroku-cli-autocomplete](https://github.com/heroku/heroku-cli-autocomplete)
[](https://developer.salesforce.com/tools/sfdxcli)
[](https://npmjs.org/package/sfdx-autocmplt)
[](https://github.com/jayree/sfdx-autocomplete-plugin/actions/workflows/release.yml)
[](https://npmjs.org/package/sfdx-autocmplt)
[](https://github.com/jayree/sfdx-autocomplete-plugin/blob/master/package.json)
## Install
```bash
sfdx plugins:install sfdx-autocmplt
```
## Usage
Run ` 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
* [`sfdx autocmplt [SHELL]`](#sfdx-autocmplt-shell)
* [`sfdx autocomplete create`](#sfdx-autocomplete-create)
* [`sfdx autocomplete doctor [SHELL]`](#sfdx-autocomplete-doctor-shell)
* [`sfdx autocomplete options [COMPLETION]`](#sfdx-autocomplete-options-completion)
* [`sfdx autocomplete script SHELL`](#sfdx-autocomplete-script-shell)
### `sfdx autocmplt [SHELL]`
display autocomplete installation instructions
```
USAGE
$ sfdx autocmplt [SHELL] [--flags-dir ] [-r]
ARGUMENTS
SHELL shell type
FLAGS
-r, --refresh-cache refresh cache only (ignores displaying instructions)
GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
DESCRIPTION
display autocomplete installation instructions
```
_See code: [src/commands/autocmplt/index.ts](https://github.com/jayree/sfdx-autocomplete-plugin/blob/v2.9.101/src/commands/autocmplt/index.ts)_
### `sfdx autocomplete create`
create autocomplete setup scripts and completion functions
```
USAGE
$ sfdx autocomplete create [--flags-dir ]
GLOBAL FLAGS
--flags-dir= 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 ] [--debug]
ARGUMENTS
SHELL shell type
FLAGS
--debug list completable commands
GLOBAL FLAGS
--flags-dir= 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 ]
GLOBAL FLAGS
--flags-dir= 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 ]
ARGUMENTS
SHELL shell type
GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
DESCRIPTION
display autocomplete setup script for shell
ALIASES
$ sfdx autocomplete script
```