UNPKG

2.4 kBMarkdownView Raw
1@oclif/plugin-commands
2======================
3
4plugin to show the list of all the commands
5
6[![Version](https://img.shields.io/npm/v/@oclif/plugin-commands.svg)](https://npmjs.org/package/@oclif/plugin-commands)
7[![CircleCI](https://circleci.com/gh/oclif/plugin-commands/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/plugin-commands/tree/main)
8[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/oclif/plugin-commands?branch=main&svg=true)](https://ci.appveyor.com/project/oclif/plugin-commands/branch/main)
9[![Downloads/week](https://img.shields.io/npm/dw/@oclif/plugin-commands.svg)](https://npmjs.org/package/@oclif/plugin-commands)
10[![License](https://img.shields.io/npm/l/@oclif/plugin-commands.svg)](https://github.com/oclif/plugin-commands/blob/main/package.json)
11
12<!-- toc -->
13* [Usage](#usage)
14* [Commands](#commands)
15<!-- tocstop -->
16# Usage
17<!-- usage -->
18```sh-session
19$ npm install -g @oclif/plugin-commands
20$ oclif-example COMMAND
21running command...
22$ oclif-example (--version)
23@oclif/plugin-commands/2.2.6 linux-x64 node-v18.13.0
24$ oclif-example --help [COMMAND]
25USAGE
26 $ oclif-example COMMAND
27...
28```
29<!-- usagestop -->
30# Commands
31<!-- commands -->
32* [`oclif-example commands`](#oclif-example-commands)
33
34## `oclif-example commands`
35
36list all the commands
37
38```
39USAGE
40 $ oclif-example commands [--json] [-h] [--hidden] [--tree] [--columns <value> | -x] [--sort <value>]
41 [--filter <value>] [--output csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
42
43FLAGS
44 -h, --help Show CLI help.
45 -x, --extended show extra columns
46 --columns=<value> only show provided columns (comma-separated)
47 --csv output is csv format [alias: --output=csv]
48 --filter=<value> filter property by partial string matching, ex: name=foo
49 --hidden show hidden commands
50 --no-header hide table header from output
51 --no-truncate do not truncate output to fit screen
52 --output=<option> output in a more machine friendly format
53 <options: csv|json|yaml>
54 --sort=<value> property to sort by (prepend '-' for descending)
55 --tree show tree of commands
56
57GLOBAL FLAGS
58 --json Format output as json.
59
60DESCRIPTION
61 list all the commands
62```
63
64_See code: [src/commands/commands.ts](https://github.com/oclif/plugin-commands/blob/v2.2.6/src/commands/commands.ts)_
65<!-- commandsstop -->