https://github.com/oclif/plugin-autocomplete

autocomplete plugin for oclif
https://github.com/oclif/plugin-autocomplete

Last synced: about 1 month ago
JSON representation

autocomplete plugin for oclif

• Host: GitHub
• URL: https://github.com/oclif/plugin-autocomplete
• Owner: oclif
• License: mit
• Created: 2018-05-18T00:06:22.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T15:53:49.000Z (4 months ago)
• Last Synced: 2024-05-22T17:00:02.379Z (4 months ago)
• Language: TypeScript
• Size: 2.15 MB
• Stars: 80
• Watchers: 3
• Forks: 31
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# @oclif/plugin-autocomplete

autocomplete plugin for oclif (bash, zsh and powershell)

[![Version](https://img.shields.io/npm/v/@oclif/plugin-autocomplete.svg)](https://npmjs.org/package/@oclif/plugin-autocomplete)

[![Downloads/week](https://img.shields.io/npm/dw/@oclif/plugin-autocomplete.svg)](https://npmjs.org/package/@oclif/plugin-autocomplete)

[![License](https://img.shields.io/npm/l/@oclif/plugin-autocomplete.svg)](https://github.com/oclif/plugin-autocomplete/blob/main/package.json)

- [@oclif/plugin-autocomplete](#oclifplugin-autocomplete)

- [Usage](#usage)

- [Commands](#commands)

- [Contributing](#contributing)

# 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

- [`oclif-example autocomplete [SHELL]`](#oclif-example-autocomplete-shell)

## `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](https://github.com/oclif/plugin-autocomplete/blob/3.2.0/src/commands/autocomplete/index.ts)_

# Contributing

See [contributing guide](./CONRTIBUTING.md)