Metadata-Version: 2.3
Name: jetbrains-cadence
Version: 1.0.0
Summary: JetBrains Cadence CLI
Author: Mikhail Meringov
Author-email: mikhail.meringov@jetbrains.com
Requires-Python: >=3.11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: awscli (>=1.41.12,<2.0.0)
Requires-Dist: click (==8.2.1)
Requires-Dist: httpx (>=0.28.1,<0.29.0)
Requires-Dist: keyring (>=25.6.0,<26.0.0)
Requires-Dist: pydantic (>=2.11.7,<3.0.0)
Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
Description-Content-Type: text/markdown

# Cadence CLI

## Install
```shell
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
```bash
echo 'eval "$(_CADENCE_COMPLETE=bash_source cadence)"' >> ~/.bashrc
```
### zsh
```zsh
echo 'eval "$(_CADENCE_COMPLETE=zsh_source cadence)"' >> ~/.zshrc
```

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

## Getting Started

```shell
cadence login
```
If you want to use Cadence CLI in the non-interactive environment, you can [create the token manually](https://api.cadence.jetbrains.com/app/jettrain/token.html) and pass it via `CADENCE_TOKEN` environment variable


#### Start the execution from YAML config
```shell
cadence execution start --preset path/to/config.yaml
```
This will print the ID of the started execution.


#### See the execution status
```shell
cadence execution status <YOUR-EXECUTION-ID>
```

#### Stop the execution
```shell
cadence execution stop <YOUR-EXECUTION-ID>
```

## More commands

#### Get information about the execution as a JSON
```shell
cadence execution info <YOUR-EXECUTION-ID>
```

#### List executions
```shell
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
```shell
cadence execution logs <YOUR-EXECUTION-ID>
```
Options:
```
  --to DIRECTORY  [required]
  --inputs        Include inputs
  --no-outputs    Exclude outputs
```

#### Open terminal
```shell
cadence execution terminal <YOUR-EXECUTION-ID>
```

#### Download data
```shell
cadence execution download <YOUR-EXECUTION-ID>
```

## Workspace management
#### Display information about the current workspace:
```shell
cadence workspace
```

#### See available workspaces:
```shell
cadence workspace list
```

#### Set workspace:
```shell
cadence workspace set <YOUR-WORKSPACE-ID>
```


