kikstart-content-cli

Kikstart Content CLI

• kikstart-content-cli
• Usage
• Commands

Usage

$ npm install -g kikstart-content-cli
$ ksc COMMAND
running command...
$ ksc (-v|--version|version)
kikstart-content-cli/1.0.2 darwin-x64 node-v12.14.1
$ ksc --help [COMMAND]
USAGE
  $ ksc COMMAND
...

Commands

• ksc generate INPUT OUTPUT
• ksc hello [FILE]
• ksc help [COMMAND]
• ksc pack INPUT OUTPUT

ksc generate INPUT OUTPUT

Generate a JSON file of a tree of Markdown files

USAGE
  $ ksc generate INPUT OUTPUT

ARGUMENTS
  INPUT   Path to input folder
  OUTPUT  Path to output folder

OPTIONS
  -h, --help                   show CLI help
  --index-file=index-file      Filename of index file
  --json-file=json-file        [default: content.json] Filename of json file
  --route-prefix=route-prefix  Adds a prefix to the routes
  --routes-file=routes-file    [default: routes.txt] Filename or routes file
  --search-file=search-file    [default: search.json] Filename of search index

See code: src/commands/generate.ts

ksc hello [FILE]

describe the command here

USAGE
  $ ksc hello [FILE]

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

EXAMPLE
  $ ksc hello
  hello world from ./src/hello.ts!

See code: src/commands/hello.ts

ksc help [COMMAND]

display help for ksc

USAGE
  $ ksc help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

ksc pack INPUT OUTPUT

Pack a tree of files into a JSON

USAGE
  $ ksc pack INPUT OUTPUT

ARGUMENTS
  INPUT   Path to folder with Markdown files
  OUTPUT  Path to output json file

OPTIONS
  -h, --help  show CLI help

See code: src/commands/pack.ts