CLI Installation

The OpenChoreo CLI (occ) is the command-line interface for managing OpenChoreo resources, projects, and deployments.

Installation

Download and install the binary for your platform:

macOS (Apple Silicon)

curl -L https://github.com/openchoreo/openchoreo/releases/download/v1.0.0-rc.1/occ_v1.0.0-rc.1_darwin_arm64.tar.gz | tar -xz && \
sudo mv occ /usr/local/bin/

macOS (Intel)

curl -L https://github.com/openchoreo/openchoreo/releases/download/v1.0.0-rc.1/occ_v1.0.0-rc.1_darwin_amd64.tar.gz | tar -xz && \
sudo mv occ /usr/local/bin/

Linux (x64)

curl -L https://github.com/openchoreo/openchoreo/releases/download/v1.0.0-rc.1/occ_v1.0.0-rc.1_linux_amd64.tar.gz | tar -xz && \
sudo mv occ /usr/local/bin/

Linux (ARM)

curl -L https://github.com/openchoreo/openchoreo/releases/download/v1.0.0-rc.1/occ_v1.0.0-rc.1_linux_arm64.tar.gz | tar -xz && \
sudo mv occ /usr/local/bin/

Verify Installation

occ version

Login

After installing the CLI, configure the OpenChoreo control plane URL and authenticate to start managing resources.

Configure Control Plane

Set the OpenChoreo API server endpoint:

occ config controlplane update default --url http://api.openchoreo.localhost:8080

note

Replace http://api.openchoreo.localhost:8080 with your actual OpenChoreo control plane URL.

If using localhost domains, add the corresponding entries to your /etc/hosts file. For example:

127.0.0.1       api.openchoreo.localhost
127.0.0.1       thunder.openchoreo.localhost
127.0.0.1       observer.openchoreo.localhost

Authenticate

Login to OpenChoreo using the web browser:

occ login

See Also

• CLI Reference: CLI Reference