Tillered Arctic
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 use

Cluster Object

FieldTypeDescription
cluster_idstringCluster identifier (ULID)
customer_idstringCustomer identifier from license
client_idstringOAuth client ID for cluster auth
client_secretstringOAuth client secret
peersarrayList of peers in this cluster
default_peerstringDefault peer ID for commands
namestringOptional human-readable name
descriptionstringOptional description

Peer Object

FieldTypeDescription
urlstringAgent API URL
peer_idstringPeer identifier (ULID)
namestringOptional human-readable name

Preferences

Global CLI preferences that apply to all commands:

FieldTypeDescriptionDefault
output_formatstringDefault output format: table, json, yamltable
colorbooleanEnable colored terminal outputtrue
timeoutintegerDefault request timeout in seconds30
cache_ttlintegerCompletion cache TTL in seconds3600
auto_failoverbooleanAuto-failover to backup peers (reserved)false

Preference Details:

  • output_format: Sets the default output format for all commands. Can be overridden with --output flag.
  • color: Controls whether CLI output uses ANSI colors. Automatically disabled when NO_COLOR environment variable is set.
  • timeout: Default HTTP request timeout for API calls. Can be overridden with --timeout flag.
  • 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 current

Switch Context

arctic config use-cluster Production

List All Contexts

arctic config list

View Full Config

arctic config view

Security Considerations

The config file contains credentials. Protect it:

chmod 600 ~/.config/arctic/config.yaml

Consider using environment variables for CI/CD:

export ARCTIC_URL="http://agent:8080"
export ARCTIC_TOKEN="eyJ..."
arctic peers list

See Also