CLI Overview
Introduction to the Arctic command-line interface
Arctic CLI Reference
The Arctic CLI (arctic) is a command-line tool for managing Arctic agents and clusters.
Installation
See the Installation guide for download and setup instructions.
Basic Usage
arctic <command> [subcommand] [flags]Commands
| Command | Description |
|---|---|
| bootstrap | Initialize an agent with a license |
| license | Manage agent license |
| config | Manage CLI configuration |
| cluster | Cluster operations |
| peers | Manage cluster peers |
| services | Manage services |
| routes | Manage service routes |
| credentials | Manage API credentials |
| health | Check agent health |
| cache | Manage completion cache |
| compose | Manage cluster via YAML config files (recommended) |
| docs | Serve embedded documentation locally |
| completion | Generate shell completion scripts |
| version | Show CLI version |
Global Flags
These flags can be used with any command. See Global Flags for details.
| Flag | Short | Description |
|---|---|---|
--context | -c | Specific context to use |
--url | Agent URL override | |
--output | -o | Output format: table, json, yaml |
--json | -j | Output in JSON format (shorthand for -o json) |
--yes | -y | Skip confirmation prompts |
--debug | Enable debug logging |
Configuration
The CLI stores configuration in ~/.config/arctic/config.yaml. This file contains:
- Cluster definitions with credentials
- Peer connection details
- Current context selection
See CLI Configuration for the full format.
Exit Codes
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | General error |
| 2 | Usage error |
| 3 | Configuration error |
| 4 | Connection error |
| 5 | Authentication error |
| 6 | Partial failure |
See Exit Codes for details.
Environment Variables
The CLI respects these environment variables:
| Variable | Description |
|---|---|
ARCTIC_CONFIG | Path to config file |
ARCTIC_CONTEXT | Default context to use |
ARCTIC_URL | Default agent URL |
ARCTIC_TOKEN | Access token |
Examples
# Bootstrap an agent
arctic bootstrap --url http://192.168.1.10:8080 --license-file license.json
# List peers
arctic peers list
# Create a service with JSON output
arctic services create --target-peer PEER_ID -j
# Delete without confirmation
arctic services delete SERVICE_ID --yes