Command-Line Tool

The cirata CLI provides terminal access to Cirata Symphony. It supports account management, extension operations, NATS interactions, metrics retrieval, object storage, and dynamic service commands discovered from connected extensions.

Obtaining the CLI

The cirata CLI is a single standalone binary with no external dependencies. It is available for:

Platform	Binary
Linux (AMD64)	cirata-linux-amd64
macOS (Apple Silicon)	cirata-darwin-arm64
Windows (AMD64)	cirata-windows-amd64.exe

CLI binaries for all three platforms are included in every Symphony installation archive. Contact the operator of this Symphony instance to obtain the binary for your platform.

The CLI binaries are included with your Symphony deployment.

Installation

After obtaining the binary, make it executable and move it to a directory in your PATH:

Linux / macOS:

chmod +x cirata-*
sudo mv cirata-* /usr/local/bin/cirata

Windows:

Move the .exe to a directory in your PATH and rename it to cirata.exe.

Shell Completion

The CLI supports tab-completion for commands, subcommands, and dynamically discovered extension commands. Run cirata --completion to generate a completion script for your current shell. Add the appropriate line to your shell startup file so it takes effect for every new session:

Bash (~/.bashrc):

eval "$(cirata --completion)"

Zsh (~/.zshrc):

eval "$(cirata --completion)"

Fish (~/.config/fish/config.fish):

cirata --completion | source

tcsh (~/.tcshrc):

eval `cirata --completion`

The --completion flag auto-detects the shell it is run from, so no additional configuration is needed.

Quick Start

# Connect to a Symphony instance
cirata login --address symphony.example.com

# View instance information
cirata info

# List extensions
cirata extension list

For the full command reference, see the CLI Reference.