Skip to content

Latest commit

 

History

History

dev

Folders and files

README.md

@commercelayer/cli-dev

Development tools of the Commerce Layer CLI (README generation for the CLI and its plugins). Private workspace package of the monorepo, not published anymore.

Version Known Vulnerabilities Downloads/week License

Usage

cl-cli-dev COMMAND

cl-cli-dev (-v | version | --version) to check the version of the CLI you have installed.

cl-cli-dev [COMMAND] (--help | -h) for detailed information about CLI commands.

Commands

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