jetbrains-cadence 1.0.0

JetBrains Cadence CLI

Cadence CLI

Install

pip install jetbrains-cadence

This will create a cadence script in your current environment.

Completions

cadence CLI uses click for its command line interface. click can automatically generate completion files for bash, fish, and zsh which can either be generated and sourced each time your shell is started or, generated once, save to a file and sourced from there. The latter version is much more efficient.

To enable shell completions:

bash

echo 'eval "$(_CADENCE_COMPLETE=bash_source cadence)"' >> ~/.bashrc

zsh

echo 'eval "$(_CADENCE_COMPLETE=zsh_source cadence)"' >> ~/.zshrc

fish

echo 'eval (env _KHAL_COMPLETE=fish_source khal)"' >> ~/.config/fish/completions/khal.fish

---

Getting Started

cadence login

If you want to use Cadence CLI in the non-interactive environment, you can create the token manually and pass it via CADENCE_TOKEN environment variable

Start the execution from YAML config

cadence execution start --preset path/to/config.yaml

This will print the ID of the started execution.

See the execution status

cadence execution status <YOUR-EXECUTION-ID>

Stop the execution

cadence execution stop <YOUR-EXECUTION-ID>

More commands

Get information about the execution as a JSON

cadence execution info <YOUR-EXECUTION-ID>

List executions

cadence execution list

Options:

  --offset INTEGER  [default: 0]
  --count INTEGER   [default: 50]
  --all             List all executions. Count and offset are ignored
  --json / --table  Output format  [default: table]

View execution logs

cadence execution logs <YOUR-EXECUTION-ID>

Options:

  --to DIRECTORY  [required]
  --inputs        Include inputs
  --no-outputs    Exclude outputs

Open terminal

cadence execution terminal <YOUR-EXECUTION-ID>

Download data

cadence execution download <YOUR-EXECUTION-ID>

Workspace management

Display information about the current workspace:

cadence workspace

See available workspaces:

cadence workspace list

Set workspace:

cadence workspace set <YOUR-WORKSPACE-ID>