CLI
Install and configure the Admiral CLI (admiral) on macOS, Windows, Linux, Docker, or from source, then use it to manage apps and drive CI/CD automation.
The Admiral CLI (admiral) is the command-line interface for interacting with the Admiral platform. Use it to manage applications, inspect platform resources, and drive CI/CD automation.
The CLI is under active development. This page covers installation and configuration. Command reference documentation will be added as the CLI stabilizes.
Installation
Install via the Admiral Homebrew tap:
brew install admiral-io/tap/admiralTo upgrade:
brew upgrade admiralTo uninstall:
brew uninstall admiralSupports both Intel (x86_64) and Apple Silicon (arm64). Shell completions for bash, zsh, and fish are installed automatically.
Verify installation
admiral versionConfiguration
The CLI reads configuration from a local config directory and supports overrides via flags and environment variables.
Setting the server and token
Connect the CLI to your Admiral instance:
admiral config set server admiral.example.com:443
admiral config set tokenThe token command prompts interactively so the value is not written to shell history. You can also set the token via environment variable:
export ADMIRAL_TOKEN="admp_..."Configuration keys
| Key | Description | Default |
|---|---|---|
server | Admiral API server address | none |
token | Authentication token (PAT or SAT) | none |
output | Default output format | table |
insecure | Skip TLS certificate verification | false |
plaintext | Disable TLS entirely (dev only) | false |
Managing configuration
# Set a value
admiral config set output json
# Get a value
admiral config get server
# List all settings
admiral config list
# Remove a setting
admiral config unset insecureGlobal flags
These flags are available on every command and override config file values:
| Flag | Short | Description |
|---|---|---|
--server | -s | API server address |
--output | -o | Output format: table, json, yaml, wide |
--insecure | -i | Skip TLS certificate verification |
--plaintext | Disable TLS | |
--verbose | -v | Enable debug logging |
--config-dir | Override config directory path |
Shell completions
If you installed via Homebrew, Scoop, or a Linux package, shell completions are set up automatically. To generate them manually:
# Bash
admiral completion bash > /usr/share/bash-completion/completions/admiral
# Zsh
admiral completion zsh > "${fpath[1]}/_admiral"
# Fish
admiral completion fish > ~/.config/fish/completions/admiral.fishAuthentication
How authentication works in hosted Admiral: sign in on the web or CLI, and use personal and service account tokens with scopes to authenticate agents and CI.
Terraform Provider
Manage Admiral resources as infrastructure-as-code with the Terraform provider: create applications, configure environments, and fold it into your pipelines.