aegis CLI

Manage policies, agents, and rollouts against Axis from any terminal - no dashboard required.

Install

Install GitHub CLI (gh) first and gh auth login with an account we've granted engineering repo access to. If you don't have that access yet, email support@velikey.com with your GitHub handle and we'll add you.

macOS (Apple Silicon)

VERSION=0.1.0
cd /tmp
gh release download "cli-v${VERSION}" \
  --repo sgreysond/velikey_aegis \
  --pattern "aegis-cli-darwin-arm64*" \
  --pattern "SHA256SUMS" --clobber
shasum -a 256 -c --ignore-missing SHA256SUMS
chmod +x aegis-cli-darwin-arm64
sudo mv aegis-cli-darwin-arm64 /usr/local/bin/aegis
aegis --version

macOS (Intel)

VERSION=0.1.0
cd /tmp
gh release download "cli-v${VERSION}" \
  --repo sgreysond/velikey_aegis \
  --pattern "aegis-cli-darwin-amd64*" \
  --pattern "SHA256SUMS" --clobber
shasum -a 256 -c --ignore-missing SHA256SUMS
chmod +x aegis-cli-darwin-amd64
sudo mv aegis-cli-darwin-amd64 /usr/local/bin/aegis

Linux (amd64)

VERSION=0.1.0
cd /tmp
gh release download "cli-v${VERSION}" \
  --repo sgreysond/velikey_aegis \
  --pattern "aegis-cli-linux-amd64*" \
  --pattern "SHA256SUMS" --clobber
sha256sum -c --ignore-missing SHA256SUMS
chmod +x aegis-cli-linux-amd64
sudo mv aegis-cli-linux-amd64 /usr/local/bin/aegis

Linux (arm64)

VERSION=0.1.0
cd /tmp
gh release download "cli-v${VERSION}" \
  --repo sgreysond/velikey_aegis \
  --pattern "aegis-cli-linux-arm64*" \
  --pattern "SHA256SUMS" --clobber
sha256sum -c --ignore-missing SHA256SUMS
chmod +x aegis-cli-linux-arm64
sudo mv aegis-cli-linux-arm64 /usr/local/bin/aegis

Configure

The CLI authenticates using an Axis API key (vk_...). Generate one under Settings -> API Keys in the dashboard. Pick a descriptive name (my-laptop-cli) and copy the generated key - Axis only displays it once.

Configure the CLI via environment variables:

export AXIS_API_KEY="vk_..."           # the key you just generated
export AXIS_BASE_URL="https://axis.velikey.com"   # default; override for self-hosted

Or pass them per command with --api-key and --base-url. The CLI sends the key as Authorization: Bearer <key>, identical to the SDKs.

Common commands

List agents in your tenant

aegis agent list

List active policies

aegis policy list --active

Show current usage + projected bill

aegis usage summary

Plan a policy rollout (dry-run, no mutation)

aegis policy rollout plan --policy-id <id> --canary-percent 10

Apply the rollout

aegis policy rollout apply --policy-id <id> --canary-percent 10

Check CLI version + help

aegis --version
aegis --help
aegis agent --help
aegis policy --help

Troubleshooting

401 Unauthorized

Verify the key is unrevoked ( Settings -> API Keys - revoked keys show as inactive). Confirm AXIS_BASE_URL matches the Axis deployment the key was issued from.

403 Subscription required

Your tenant's subscription is not active or trialing. Add a payment method under Billing or contact support.

"command not found: aegis"

The binary landed somewhere not on $PATH. Either move it to /usr/local/bin/ (requires sudo) or add its current directory to your shell's PATH export.

What the CLI can't do (yet)

• Create / modify policies. Use the dashboard for policy authoring; the CLI can list and roll out existing policies.
• Create / delete agents. Agents enroll themselves with a bootstrap token; the CLI can list, inspect, and remove them.
• User-management operations (2FA, SSO, billing). These stay in the dashboard by design.

CLI distribution and source access are provided through authorized customer onboarding. The source repository requires granted access; contact support for CLI access and roadmap questions.