Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

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: about 1 month 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 (over 5 years ago)
Default Branch: main
Last Pushed: 2024-04-12T08:17:12.000Z (about 1 month ago)
Last Synced: 2024-04-12T12:11:53.716Z (about 1 month ago)
Language: TypeScript
Homepage:
Size: 2.56 MB
Stars: 10
Watchers: 1
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Lists

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

[![sfdx](https://img.shields.io/badge/cli-sfdx-brightgreen.svg)](https://developer.salesforce.com/tools/sfdxcli)

[![Version](https://img.shields.io/npm/v/sfdx-autocmplt.svg)](https://npmjs.org/package/sfdx-autocmplt)

[![test-and-release](https://github.com/jayree/sfdx-autocomplete-plugin/actions/workflows/release.yml/badge.svg)](https://github.com/jayree/sfdx-autocomplete-plugin/actions/workflows/release.yml)

[![Downloads/week](https://img.shields.io/npm/dw/sfdx-autocmplt.svg)](https://npmjs.org/package/sfdx-autocmplt)

[![License](https://img.shields.io/npm/l/sfdx-autocmplt.svg)](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`](#sfdx-autocmplt)

* [`sfdx autocomplete create`](#sfdx-autocomplete-create)

* [`sfdx autocomplete doctor`](#sfdx-autocomplete-doctor)

* [`sfdx autocomplete options`](#sfdx-autocomplete-options)

* [`sfdx autocomplete script`](#sfdx-autocomplete-script)

### `sfdx autocmplt`

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.48/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`

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`

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`

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

```