ReferenceConfiguration Reference
CLI Configuration
Arctic CLI configuration file format
CLI Configuration
The Arctic CLI stores connection details in a configuration file.
File Location
Default: ~/.config/arctic/config.yaml
Override with the --config flag or ARCTIC_CONFIG environment variable.
Configuration Format
Groups peers by cluster with shared credentials and global preferences:
current_cluster: 01HABCDEF456...
clusters:
01HABCDEF456...:
cluster_id: 01HABCDEF456...
customer_id: cust_xyz789...
client_id: cl_01HXYZ...
client_secret: sec_abc123...
peers:
- url: http://192.168.1.10:8080
peer_id: 01HXYZABC123...
name: Agent A
- url: http://192.168.1.20:8080
peer_id: 01HXYZDEF789...
name: Agent B
default_peer: 01HXYZABC123...
name: Production
preferences:
cache_ttl: 3600 # Cache TTL in seconds (default: 3600)
auto_failover: false # Reserved for future useCluster Object
| Field | Type | Description |
|---|---|---|
cluster_id | string | Cluster identifier (ULID) |
customer_id | string | Customer identifier from license |
client_id | string | OAuth client ID for cluster auth |
client_secret | string | OAuth client secret |
peers | array | List of peers in this cluster |
default_peer | string | Default peer ID for commands |
name | string | Optional human-readable name |
description | string | Optional description |
Peer Object
| Field | Type | Description |
|---|---|---|
url | string | Agent API URL |
peer_id | string | Peer identifier (ULID) |
name | string | Optional human-readable name |
Preferences
Global CLI preferences that apply to all commands:
| Field | Type | Description | Default |
|---|---|---|---|
output_format | string | Default output format: table, json, yaml | table |
color | boolean | Enable colored terminal output | true |
timeout | integer | Default request timeout in seconds | 30 |
cache_ttl | integer | Completion cache TTL in seconds | 3600 |
auto_failover | boolean | Auto-failover to backup peers (reserved) | false |
Preference Details:
- output_format: Sets the default output format for all commands. Can be overridden with
--outputflag. - color: Controls whether CLI output uses ANSI colors. Automatically disabled when
NO_COLORenvironment variable is set. - timeout: Default HTTP request timeout for API calls. Can be overridden with
--timeoutflag. - cache_ttl: Time-to-live for the completion cache in seconds. Cache is considered stale after this duration. See Completion Cache for details.
- auto_failover: Reserved for future peer failover feature. Currently not implemented.
Managing Configuration
View Current Context
arctic config currentSwitch Context
arctic config use-cluster ProductionList All Contexts
arctic config listView Full Config
arctic config viewSecurity Considerations
The config file contains credentials. Protect it:
chmod 600 ~/.config/arctic/config.yamlConsider using environment variables for CI/CD:
export ARCTIC_URL="http://agent:8080"
export ARCTIC_TOKEN="eyJ..."
arctic peers list