@commercelayer/cli-dev

@oclif/dev-cli

helpers for oclif CLIs

• Usage
• Commands

Usage

$ npm install -g @commercelayer/cli-dev
$ cl-cli-dev COMMAND
running command...
$ cl-cli-dev (--version)
@commercelayer/cli-dev/0.1.0 darwin-x64 node-v16.13.2
$ cl-cli-dev --help [COMMAND]
USAGE
  $ cl-cli-dev COMMAND
...

Commands

• cl-cli-dev readme

cl-cli-dev readme

adds commands to README.md in current directory

USAGE
  $ cl-cli-dev readme --dir <value> [--multi] [--bin <value> --plugin]

FLAGS
  --bin=<value>  optional main cli command
  --dir=<value>  (required) [default: docs] output directory for multi docs
  --multi        create a different markdown page for each topic
  --plugin       create a plugin readme doc

DESCRIPTION
  adds commands to README.md in current directory

  The readme must have any of the following tags inside of it for it to be replaced or else it will do nothing:

  ## Usage

  <!-- usage -->

  ## Commands

  <!-- commands -->

  Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.

See code: src/commands/readme.ts