Skip to main content
Version: Next

CLI Installation

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

Installation​

First, download the latest development build from GitHub:
curl -L https://nightly.link/openchoreo/openchoreo/workflows/build-and-test/main/occ.zip -o occ.zip
unzip occ.zip
Use the appropriate platform binary for the next step
  • macOS (Intel): darwin/amd64
  • macOS (Apple Silicon): darwin/arm64
  • Linux (x64): linux/amd64
  • Linux (ARM): linux/arm64
# Use the appropriate platform suffix (e.g., darwin/arm64, linux/amd64)
chmod +x <platform>/occ
sudo mv <platform>/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​