metrist-cli

Metrist CLI

• Usage
• Commands
• Contributing

Usage

$ npm install -g @metrist/cli
$ metrist COMMAND
running command...
$ metrist (--version)
@metrist/cli/0.0.0 linux-x64 node-v16.15.1
$ metrist --help [COMMAND]
USAGE
  $ metrist COMMAND
...

Commands

• metrist configure
• metrist hello PERSON
• metrist hello world

metrist configure

Configure Metrist CLI options

USAGE
  $ metrist configure

DESCRIPTION
  Configure Metrist CLI options


  Configure Metrist CLI options. If your config file does not exists (~/.config/metrist/config.json), then Metrist CLI
  will create it for you. To keep an existing value, hit enter when the prompted for the value.


EXAMPLES
  $ metrist configure

See code: dist/commands/configure.ts

metrist hello PERSON

Say hello

USAGE
  $ metrist hello [PERSON] -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (required) Who is saying hello

DESCRIPTION
  Say hello

EXAMPLES
  $ metrist hello friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)

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

metrist hello world

Say hello world

USAGE
  $ metrist hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ metrist hello world
  hello world! (./src/commands/hello/world.ts)

Contributing

Setting up environment

asdf install
npm i
./bin/dev --help
./bin/dev your_command args

To show debug logs add the DEBUG environment var
DEBUG=\* ./bin/dev your_command args

To create new command

1. Use the oclif generator https://oclif.io/docs/generator_commands
2. In the generated files, rename extends Command to extends BaseCommand
3. Run npm run version to update the README.md file