An open API service indexing awesome lists of open source software.

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


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

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

          

# @oclif/plugin-commands

plugin to show the list of all the commands

[![Version](https://img.shields.io/npm/v/@oclif/plugin-commands.svg)](https://npmjs.org/package/@oclif/plugin-commands)
[![Downloads/week](https://img.shields.io/npm/dw/@oclif/plugin-commands.svg)](https://npmjs.org/package/@oclif/plugin-commands)
[![License](https://img.shields.io/npm/l/@oclif/plugin-commands.svg)](https://github.com/oclif/plugin-commands/blob/main/package.json)

- [@oclif/plugin-commands](#oclifplugin-commands)
- [Usage](#usage)
- [Commands](#commands)
- [Contributing](#contributing)

# Usage

```sh-session
$ npm install -g @oclif/plugin-commands
$ oclif-example COMMAND
running command...
$ oclif-example (--version)
@oclif/plugin-commands/4.1.56 linux-x64 node-v22.22.3
$ oclif-example --help [COMMAND]
USAGE
$ oclif-example COMMAND
...
```

# Commands

- [`oclif-example commands`](#oclif-example-commands)

## `oclif-example commands`

List all oclif-example commands.

```
USAGE
$ oclif-example commands [--json] [-c id|plugin|summary|type... | --tree] [--deprecated] [-x | ] [--hidden]
[--no-truncate | ] [--sort id|plugin|summary|type | ]

FLAGS
-c, --columns=... Only show provided columns (comma-separated).

-x, --extended Show extra columns.
--deprecated Show deprecated commands.
--hidden Show hidden commands.
--no-truncate Do not truncate output.
--sort= [default: id] Property to sort by.

--tree Show tree of commands.

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
List all oclif-example commands.
```

_See code: [src/commands/commands.ts](https://github.com/oclif/plugin-commands/blob/4.1.56/src/commands/commands.ts)_

# Contributing

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