Jitsu CLI

jitsu-cli is the command-line interface for Jitsu. It manages workspace configuration objects (destinations, streams, connections, …) and runs the Functions dev workflow.

The CLI calls the same Management API the Jitsu UI uses.

Install

npm i -g jitsu-cli

Verify:

jitsu-cli --version

First steps

jitsu-cli login                                # log in once
jitsu-cli set-default-workspace my-workspace   # optional — saves you typing -w on every command
jitsu-cli config destinations list             # uses the saved workspace

See Authentication for login options and Config for managing configuration objects.

Command groups

CommandDescription
login / logout / whoamiAuthenticate and inspect session
set-default-workspace / unset-default-workspacePin a workspace so -w becomes optional
config <noun> <verb>Manage workspaces, destinations, streams, services, functions, connections, …
init / build / test / deployFunctions extension dev workflow — see Functions SDK

Global options

Most commands accept these:

  • -h, --host <host> — Jitsu host (default https://use.jitsu.com). Overrides the saved auth file.
  • -k, --apikey <keyId:secret> — API key. Overrides the saved auth file.
  • -w, --workspace <id-or-slug> — Target workspace. Falls back to the default workspace if set.
  • -o, --output <format> — Output format for read commands (e.g. json, yaml, table).

When --host and --apikey are both omitted, the CLI uses the credentials saved by jitsu-cli login.