# @oclif/plugin-autocomplete

> autocomplete plugin for oclif

Latest version **4.0.0** (published 2026-08-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install @oclif/plugin-autocomplete
pnpm add @oclif/plugin-autocomplete
yarn add @oclif/plugin-autocomplete
bun add @oclif/plugin-autocomplete
```

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2026-08-31 |
| First published | 2018-06-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=22.0.0 |
| Dependencies | 4 |
| Unpacked size | 61.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 95 |
| Author | Salesforce |
| Maintainers | jimjag, salesforce-releases |
| Keywords | oclif-plugin |

## Links

- npm: https://www.npmjs.com/package/@oclif/plugin-autocomplete
- Repository: https://github.com/oclif/plugin-autocomplete
- Issues: https://github.com/oclif/plugin-autocomplete/issues
- npm.io page: https://npm.io/package/@oclif/plugin-autocomplete

## Dependencies (4)

- [ejs](https://npm.io/package/ejs.md) ^3.1.10
- [ansis](https://npm.io/package/ansis.md) ^3.16.0
- [debug](https://npm.io/package/debug.md) ^4.4.1
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^5.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 4.0.0 (latest) — 2026-08-31
- 3.2.37-autocomplete.1 (autocomplete) — 2025-10-14
- 2.3.11-dev.1 (dev) — 2023-10-27
- 1.4.0-beta.1 (beta) — 2022-10-18
- 3.3.0 — 2026-08-24
- 3.2.56 — 2026-08-09
- 3.2.55 — 2026-08-02
- 3.2.54 — 2026-07-26
- 3.2.53 — 2026-06-28
- 3.2.52 — 2026-06-22
- 3.2.51 — 2026-06-21
- 3.2.50 — 2026-05-24
- 3.2.49 — 2026-05-10
- 3.2.48 — 2026-05-09
- 3.2.47 — 2026-05-03
- … 132 more at https://npm.io/package/@oclif/plugin-autocomplete/versions

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

<!-- toc -->
* [@oclif/plugin-autocomplete](#oclifplugin-autocomplete)
* [Usage](#usage)
* [Commands](#commands)
* [Contributing](#contributing)
<!-- tocstop -->

# 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 -->
* [`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/v4.0.0/src/commands/autocomplete/index.ts)_
<!-- commandsstop -->

# Contributing

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

---
_Source: https://npm.io/package/@oclif/plugin-autocomplete · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._