Katacoda CLI

Create and manage Katacoda content from the command-line

  

• Katacoda CLI
• Usage
• Commands

Usage

$ npm install -g katacoda-cli
$ katacoda COMMAND
running command...
$ katacoda (-v|--version|version)
katacoda-cli/0.0.24 darwin-x64 node-v12.16.2
$ katacoda --help [COMMAND]
USAGE
  $ katacoda COMMAND
...

Commands

• katacoda commands
• katacoda courses:add:scenarios
• katacoda courses:create
• katacoda courses:delete
• katacoda help [COMMAND]
• katacoda scenarios:add:asset
• katacoda scenarios:add:steps
• katacoda scenarios:create
• katacoda scenarios:delete
• katacoda scenarios:demo
• katacoda scenarios:remove:steps
• katacoda scenarios:validate
• katacoda scenarios:validate:all
• katacoda training:create
• katacoda validate:all

katacoda commands

list all the commands

USAGE
  $ katacoda commands

OPTIONS
  -h, --help  show CLI help
  -j, --json  output in json format
  --hidden    also show hidden commands

See code: @oclif/plugin-commands

katacoda courses:add:scenarios

Add a existing scenario to course

USAGE
  $ katacoda courses:add:scenarios

See code: src/commands/courses/add/scenarios.ts

katacoda courses:create

Create a new Katacoda course

USAGE
  $ katacoda courses:create

See code: src/commands/courses/create.ts

katacoda courses:delete

Delete a Katacoda course

USAGE
  $ katacoda courses:delete

See code: src/commands/courses/delete.ts

katacoda help [COMMAND]

display help for katacoda

USAGE
  $ katacoda help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

katacoda scenarios:add:asset

Add assets to scenario

USAGE
  $ katacoda scenarios:add:asset

OPTIONS
  -a, --asset=asset    path to asset
  -t, --target=target  directory the file should be uploaded to

See code: src/commands/scenarios/add/asset.ts

katacoda scenarios:add:steps

Add steps to scenario

USAGE
  $ katacoda scenarios:add:steps

OPTIONS
  -p, --scenariopath=scenariopath  path to scenario
  -s, --steps=steps                Number of steps

See code: src/commands/scenarios/add/steps.ts

katacoda scenarios:create

Create a new Katacoda scenario

USAGE
  $ katacoda scenarios:create

See code: src/commands/scenarios/create.ts

katacoda scenarios:delete

Safely remove a scenario

USAGE
  $ katacoda scenarios:delete

See code: src/commands/scenarios/delete.ts

katacoda scenarios:demo

Generate a demo scenario

USAGE
  $ katacoda scenarios:demo

See code: src/commands/scenarios/demo.ts

katacoda scenarios:remove:steps

Remove steps from scenario

USAGE
  $ katacoda scenarios:remove:steps

OPTIONS
  -p, --scenariopath=scenariopath  path to scenario
  -s, --steps=steps                steps to delete

See code: src/commands/scenarios/remove/steps.ts

katacoda scenarios:validate

Validate if the scenario structure is correct

USAGE
  $ katacoda scenarios:validate

See code: src/commands/scenarios/validate.ts

katacoda scenarios:validate:all

Validate structure of all scenarios

USAGE
  $ katacoda scenarios:validate:all

OPTIONS
  --ignore=ignore
  --repo=repo

See code: src/commands/scenarios/validate/all.ts

katacoda training:create

Create a new Katacoda training

USAGE
  $ katacoda training:create

See code: src/commands/training/create.ts

katacoda validate:all

Validate structure of all scenarios

USAGE
  $ katacoda validate:all

OPTIONS
  --ignore=ignore
  --repo=repo

See code: src/commands/validate/all.ts