oclif-template

oclif-template

Development

Starting a development session is easy, just run yarn nodemon once all dependencies are installed. You can create an alias to the absolute path to ./bin/run so you can easily run the CLI in development to test. In Linux, if you use bash, you can add to the end of ~/.bashrc the following line:

alias YOUR_CLI_NAME-test="ABSOLUTE_PATH_TO_YOUR_CLI_FOLDER/bin/run"

After restarting the active terminals you'll be able to run YOUR_CLI_NAME-test and you'll be running the dev version of your CLI.

In MacOS you can add to the end of ~/.bash_profile (if you use bash) the same line presented above - maybe you'll have to restart the computer for the new alias to take effect.

• Development
• Usage
• Commands

Usage

$ npm install -g oclif-template
$ cli COMMAND
running command...
$ cli (-v|--version|version)
oclif-template/0.0.1 linux-x64 node-v12.13.0
$ cli --help [COMMAND]
USAGE
  $ cli COMMAND
...

Commands

• cli help [COMMAND]
• cli ls
• cli say:bye
• cli say:hello [FILE]
• cli update [CHANNEL]

cli help [COMMAND]

display help for cli

USAGE
  $ cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

cli ls

List local files

USAGE
  $ cli ls

EXAMPLE
  cli ls

See code: src/commands/ls.ts

cli say:bye

Say bye

USAGE
  $ cli say:bye

EXAMPLE
  cli say bye

See code: src/commands/say/bye.ts

cli say:hello [FILE]

Say hello

USAGE
  $ cli say:hello [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

EXAMPLES
  cli say hello
  cli say hello --name="tiago"
  cli say hello -n tiago
  cli say hello --force --file asdf.txt

See code: src/commands/say/hello.ts

cli update [CHANNEL]

update the cli CLI

USAGE
  $ cli update [CHANNEL]

See code: @oclif/plugin-update