@stackblitz/cli

@stackblitz/cli

StackBlitz CLI

• @stackblitz/cli
• Usage
• Commands

Usage

$ npm install -g @stackblitz/cli
$ sb COMMAND
running command...
$ sb (-v|--version|version)
@stackblitz/cli/0.3.2 darwin-x64 node-v8.15.1
$ sb --help [COMMAND]
USAGE
  $ sb COMMAND
...

Commands

• sb clean [TARGET]
• sb config
• sb generate ACTION [GENERATOR]
• sb help [COMMAND]
• sb image [ACTION] [IMAGE]
• sb run WORKSPACE
• sb task ACTION [TASK]

sb clean [TARGET]

Shortcuts to clean up resources

USAGE
  $ sb clean [TARGET]

OPTIONS
  -f, --force

ALIASES
  $ sb c

See code: src/commands/clean.ts

sb config

Show the config in the current workspace and the global config

USAGE
  $ sb config

See code: src/commands/config.ts

sb generate ACTION [GENERATOR]

Run generators defined in the StackBlitz config and from GitHub Gists

USAGE
  $ sb generate ACTION [GENERATOR]

ARGUMENTS
  ACTION     (gist|list|run) the action
  GENERATOR  the generator you want run

OPTIONS
  -f, --force          force creation, overwriting existing files
  -h, --help           show CLI help
  -o, --output=output  location to the output dir

ALIASES
  $ sb g

See code: src/commands/generate.ts

sb help [COMMAND]

display help for sb

USAGE
  $ sb help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

sb image [ACTION] [IMAGE]

Run operations on the images defined in StackBlitz config

USAGE
  $ sb image [ACTION] [IMAGE]

ARGUMENTS
  ACTION  (build|list|pull|push|run) Operation to run
  IMAGE   Image to run operation on

OPTIONS
  -h, --help                 show CLI help
  -w, --workspace=workspace  The project working directory

See code: src/commands/image.ts

sb run WORKSPACE

Run project in a workspace, optionally provisioning it with a template or GitHub project.

USAGE
  $ sb run WORKSPACE

ARGUMENTS
  WORKSPACE  [default: /opt/stackblitz/cli] The project working directory

OPTIONS
  -c, --cmd=cmd            Command to execute
  -h, --help               show CLI help
  -i, --skipInstall        Install dependencies
  -k, --check=check        [default: ./package.json] Location to file to check if project exists or needs provisioning
  -s, --skipStart          Only provision the project but do not start it
  -t, --template=template  The file or url used to provision the workspace
  -w, --cwd=cwd            The current working directory where commands are executed

See code: src/commands/run.ts

sb task ACTION [TASK]

Run tasks defined in the StackBlitz config

USAGE
  $ sb task ACTION [TASK]

ARGUMENTS
  ACTION  (list|run) the action
  TASK    the task you want run

OPTIONS
  -h, --help  show CLI help

See code: src/commands/task.ts