UNPKG

1.72 kBMarkdownView Raw
1@oclif/plugin-autocomplete
2==========================
3
4autocomplete plugin for oclif (bash & zsh)
5
6[![Version](https://img.shields.io/npm/v/@oclif/plugin-autocomplete.svg)](https://npmjs.org/package/@oclif/plugin-autocomplete)
7[![CircleCI](https://circleci.com/gh/oclif/plugin-autocomplete/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/plugin-autocomplete/tree/main)
8[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/oclif/plugin-autocomplete?branch=main&svg=true)](https://ci.appveyor.com/project/oclif/plugin-autocomplete/branch/main)
9[![Downloads/week](https://img.shields.io/npm/dw/@oclif/plugin-autocomplete.svg)](https://npmjs.org/package/@oclif/plugin-autocomplete)
10[![License](https://img.shields.io/npm/l/@oclif/plugin-autocomplete.svg)](https://github.com/oclif/plugin-autocomplete/blob/main/package.json)
11
12<!-- toc -->
13* [Usage](#usage)
14* [Commands](#commands)
15<!-- tocstop -->
16# Usage
17See https://oclif.io/docs/plugins.html
18# Commands
19<!-- commands -->
20* [`oclif-example autocomplete [SHELL]`](#oclif-example-autocomplete-shell)
21
22## `oclif-example autocomplete [SHELL]`
23
24display autocomplete installation instructions
25
26```
27USAGE
28 $ oclif-example autocomplete [SHELL] [-r]
29
30ARGUMENTS
31 SHELL shell type
32
33FLAGS
34 -r, --refresh-cache Refresh cache (ignores displaying instructions)
35
36DESCRIPTION
37 display autocomplete installation instructions
38
39EXAMPLES
40 $ oclif-example autocomplete
41
42 $ oclif-example autocomplete bash
43
44 $ oclif-example autocomplete zsh
45
46 $ oclif-example autocomplete --refresh-cache
47```
48
49_See code: [src/commands/autocomplete/index.ts](https://github.com/oclif/plugin-autocomplete/blob/v1.3.6/src/commands/autocomplete/index.ts)_
50<!-- commandsstop -->