CLI Installation

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

Installation

Download and install the latest development build from GitHub:

macOS (Apple Silicon)

curl -L https://nightly.link/openchoreo/openchoreo/workflows/build-and-test/main/occ.zip -o occ.zip && \
unzip occ.zip && \
sudo mv darwin/arm64/occ /usr/local/bin/ && \
rm -rf occ.zip darwin linux

macOS (Intel)

curl -L https://nightly.link/openchoreo/openchoreo/workflows/build-and-test/main/occ.zip -o occ.zip && \
unzip occ.zip && \
sudo mv darwin/amd64/occ /usr/local/bin/ && \
rm -rf occ.zip darwin linux

Linux (x64)

curl -L https://nightly.link/openchoreo/openchoreo/workflows/build-and-test/main/occ.zip -o occ.zip && \
unzip occ.zip && \
sudo mv linux/amd64/occ /usr/local/bin/ && \
rm -rf occ.zip darwin linux

Linux (ARM)

curl -L https://nightly.link/openchoreo/openchoreo/workflows/build-and-test/main/occ.zip -o occ.zip && \
unzip occ.zip && \
sudo mv linux/arm64/occ /usr/local/bin/ && \
rm -rf occ.zip darwin linux

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