UNPKG

2.37 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/master.svg?style=shield)](https://circleci.com/gh/oclif/plugin-commands/tree/master)
8[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/oclif/plugin-commands?branch=master&svg=true)](https://ci.appveyor.com/project/oclif/plugin-commands/branch/master)
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/master/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.0.1 linux-x64 node-v12.22.7
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 [-h] [-j] [--hidden] [--columns <value> | -x] [--sort <value>] [--filter <value>]
41 [--output csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
42
43FLAGS
44 -h, --help Show CLI help.
45 -j, --json display unfiltered api data in json format
46 -x, --extended show extra columns
47 --columns=<value> only show provided columns (comma-separated)
48 --csv output is csv format [alias: --output=csv]
49 --filter=<value> filter property by partial string matching, ex: name=foo
50 --hidden show hidden commands
51 --no-header hide table header from output
52 --no-truncate do not truncate output to fit screen
53 --output=<option> output in a more machine friendly format
54 <options: csv|json|yaml>
55 --sort=<value> property to sort by (prepend '-' for descending)
56
57DESCRIPTION
58 list all the commands
59```
60
61_See code: [src/commands/commands.ts](https://github.com/oclif/plugin-commands/blob/v2.0.1/src/commands/commands.ts)_
62<!-- commandsstop -->