stepzen

StepZen CLI

The StepZen Command Line Interface (CLI) tool enables you to set up and manage StepZen using commands in your command-line shell.

After you have written your GraphQL schema in the form of a Schema Definition Language (SDL) file, and defined your "configuration" in a YAML files, you can upload and deploy them to StepZen using the StepZen CLI - resulting in a live GraphQL endpoint.

Installing

npm install -g stepzen

Verifying your installation

To verify your CLI installation, use the stepzen --version command:

$ stepzen (-v|--version|version)

---

• StepZen CLI
• Installing
• Verifying your installation
• Usage
• Commands

Usage

$ npm install -g stepzen
$ stepzen COMMAND
running command...
$ stepzen (-v|--version|version)
stepzen/0.9.23 darwin-x64 node-v14.1.0
$ stepzen --help [COMMAND]
USAGE
  $ stepzen COMMAND
...

Commands

• stepzen deploy DESTINATION
• stepzen help [COMMAND]
• stepzen import SCHEMAS
• stepzen list TYPE
• stepzen login
• stepzen logout
• stepzen start
• stepzen upload TYPE DESTINATION

stepzen deploy DESTINATION

deploy to stepzen

USAGE
  $ stepzen deploy DESTINATION

ARGUMENTS
  DESTINATION  destination

OPTIONS
  -h, --help                             show CLI help
  --configurationsets=configurationsets  Configurationsets to use
  --dataset=dataset                      Dataset to use
  --schema=schema                        (required) Schema to use
  --silent

See code: src/commands/deploy.ts

stepzen help [COMMAND]

display help for stepzen

USAGE
  $ stepzen help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

stepzen import SCHEMAS

import schemas from stepzen

USAGE
  $ stepzen import SCHEMAS

OPTIONS
  -h, --help               show CLI help
  --dir=dir                working directory
  --local-dir=local-dir    import from a local directory of schemas
  --repository=repository  import from a remote repository
  --subdir=subdir          allows a subdirectory to be used, if importing from a remote repository

See code: src/commands/import.ts

stepzen list TYPE

list your items

USAGE
  $ stepzen list TYPE

ARGUMENTS
  TYPE  (configurationsets|datasets|schemas) type

OPTIONS
  -h, --help  show CLI help

See code: src/commands/list.ts

stepzen login

log in to stepzen

USAGE
  $ stepzen login

OPTIONS
  -h, --help  show CLI help

See code: src/commands/login.ts

stepzen logout

log out of stepzen

USAGE
  $ stepzen logout

OPTIONS
  -h, --help  show CLI help

See code: src/commands/logout.ts

stepzen start

start stepzen dashboard

USAGE
  $ stepzen start

OPTIONS
  -h, --help           show CLI help
  --dir=dir            working directory
  --endpoint=endpoint  Override workspace endpoint
  --port=port          [default: 5000]

See code: src/commands/start.ts

stepzen upload TYPE DESTINATION

upload to stepzen

USAGE
  $ stepzen upload TYPE DESTINATION

ARGUMENTS
  TYPE         (configurationset|dataset|schema) type
  DESTINATION  destination

OPTIONS
  -h, --help   show CLI help
  --dir=dir    A directory to upload
  --file=file  A file to upload
  --silent

See code: src/commands/upload.ts