Skip to main content

​
What is Ankra CLI?

The Ankra CLI is a powerful command-line interface for interacting with the Ankra platform. It enables you to manage clusters, chat with AI about your infrastructure, browse Helm charts, manage credentials, deploy stacks, and automate platform operations directly from your terminal.

​
Installation

After installation, verify with:

​
Direct Download

Download the binary directly from GitHub Releases.

​
Upgrading the CLI

The CLI can update itself in place with ankra upgrade (aliased as ankra self-update). The downloaded binary is verified against its published SHA-256 checksum before it replaces the running executable.
If the binary lives in a root-owned location, run sudo ankra upgrade or re-run the install script.

​
Beta (pre-release) channel

Opt in to release candidates (such as v0.3.0-rc.1) so ankra upgrade resolves the newest release including pre-releases:
The channel preference is stored locally in ~/.ankra/settings.json (separate from your credentials).

​
Authentication

The easiest way to authenticate is using browser-based SSO:
This will:
  1. Open your browser to the Ankra login page
  2. After you authenticate, save your credentials locally
  3. You can then use all ankra CLI commands
Your credentials are saved to ~/.ankra.yaml. To logout and clear credentials:

​
Environment Variables (Alternative)

You can also use environment variables:
Add to your shell profile (~/.zshrc or ~/.bashrc) for persistence.

​
Quick Start

​
Machine-readable output (-o json|yaml)

Commands that read or return data support structured output via the shared -o/--output flag, so scripts and AI agents never have to parse tables or prose:
  • -o json prints the result as indented JSON; -o yaml emits the same data as YAML.
  • The kubectl-style commands (cluster get ..., cluster helm releases, cluster metrics ...) default to -o table and accept json/yaml as alternatives.
Write commands (reconcile, provision, deprovision, scaling, node groups, token creation, …) also accept -o json and emit the API result - including operation IDs - so automation can poll ankra cluster operations list <id> -o json for completion. Asynchronous writes submitted without --wait emit {"submitted": true, ...}.

​
Command Reference

The full command reference - every command, subcommand, flag, and default - is generated from the CLI source on each release, so it never drifts:

CLI Command Reference

Browse all 18 command families: cluster, credentials, tokens, profile, org, chat, skills, and more.
Highlights:

​
Configuration

The CLI stores configuration in ~/.ankra.yaml:
Token resolution priority (highest to lowest):
  1. --token flag (explicit CLI argument)
  2. Config file token (saved by ankra login)
  3. ANKRA_API_TOKEN environment variable
The base URL can be overridden with --base-url or the ANKRA_BASE_URL environment variable.

​
Troubleshooting

​
Common Issues

PATH issues:
Authentication errors:
Check version:
Get help:

​
Error Messages

  • “No active cluster selected” Run ankra cluster select first
  • “Resource not found” Verify the resource name and selected cluster
  • “Unauthorized” Re-authenticate with ankra login

​
Support & Resources

For more advanced usage, see the full documentation or contact support.