oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g btns-cli
$ btns COMMAND
running command...
$ btns (--version)
btns-cli/0.0.3 darwin-arm64 node-v14.18.1
$ btns --help [COMMAND]
USAGE
  $ btns COMMAND
...

Commands

• btns get [PLUGIN]
• btns help [COMMAND]
• btns new [PLUGIN] [DESCRIPTION]
• btns register
• btns release

btns get [PLUGIN]

Download existing plugin from btns server

USAGE
  $ btns get [PLUGIN] [-f]

FLAGS
  -f, --force  Force replace all files with base templates

DESCRIPTION
  Download existing plugin from btns server

EXAMPLES
  $ btns get my-plugin

See code: dist/commands/get/index.ts

btns help [COMMAND]

Display help for btns.

USAGE
  $ btns help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for btns.

See code: @oclif/plugin-help

btns new [PLUGIN] [DESCRIPTION]

Generate new btns plugin files locally

USAGE
  $ btns new [PLUGIN] [DESCRIPTION] [-g] [-f] [-s]

FLAGS
  -f, --force   Force replace all files with base templates
  -g, --github  This plugin should integrate with a github repository
  -s, --shared  This plugin is shared and can be used by anyone.

DESCRIPTION
  Generate new btns plugin files locally

EXAMPLES
  $ btns new my-plugin

See code: dist/commands/new/index.ts

btns register

Save plugin information on btns server as v1

USAGE
  $ btns register [-g <value>]

FLAGS
  -g, --github=<value>  This plugin should integrate with a github repository

DESCRIPTION
  Save plugin information on btns server as v1

EXAMPLES
  $ btns register my-plugin

See code: dist/commands/register/index.ts

btns release

Update plugin on btns server, with a new version.

USAGE
  $ btns release [-g <value>]

FLAGS
  -g, --github=<value>  This plugin should integrate with a github repository

DESCRIPTION
  Update plugin on btns server, with a new version.

EXAMPLES
  $ btns release my-plugin

See code: dist/commands/release/index.ts