Skip to main content
Version: v0.14.x

CLI Installation

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

Installation​

First, download the appropriate binary from the GitHub release:
  • macOS (Intel): occ_v0.14.0_darwin_amd64.tar.gz
  • macOS (Apple Silicon): occ_v0.14.0_darwin_arm64.tar.gz
  • Linux (x64): occ_v0.14.0_linux_amd64.tar.gz
  • Linux (ARM): occ_v0.14.0_linux_arm64.tar.gz
macOS/Linux:
tar -xzf occ_v0.14.0_<platform>.tar.gz
chmod +x occ
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 set-control-plane --url http://api.openchoreo.localhost:8080 --name default
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

Authenticate​

Login to OpenChoreo using the web browser:

occ login

See Also​