readme-docs-cli

readme-docs-cli

Readme.com CLI

• Usage
• Commands

Usage

$ npm install -g readme-docs-cli
$ readme COMMAND
running command...
$ readme (-v|--version|version)
readme-docs-cli/0.4.2 darwin-x64 node-v12.14.0
$ readme --help [COMMAND]
USAGE
  $ readme COMMAND
...

Commands

• readme bulk-category-change CSVFILEPATH
• readme change-category DOCSLUG NEWCATEGORYSLUG
• readme help [COMMAND]

readme bulk-category-change CSVFILEPATH

Change category of docs in bulk by reading a CSV file

USAGE
  $ readme bulk-category-change CSVFILEPATH

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ readme bulk-category-change example.csv

See code: src/commands/bulk-category-change.ts

readme change-category DOCSLUG NEWCATEGORYSLUG

Change category of a documentation

USAGE
  $ readme change-category DOCSLUG NEWCATEGORYSLUG

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ readme change-category "vtex_io-documentation_customizing-your-stores-typography" "Style Recipes"

See code: src/commands/change-category.ts

readme help [COMMAND]

display help for readme

USAGE
  $ readme help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help