Tillered Arctic

Reference

Complete reference documentation for Arctic CLI, API, and configuration

Reference Documentation

This section provides comprehensive reference documentation for all Arctic commands, API endpoints, and configuration options.

CLI Reference

Complete documentation for the Arctic command-line interface:

CLI Overview

Introduction to the Arctic CLI

Global Flags

Flags available for all commands

Exit Codes

Command exit codes and meanings

Commands

CommandDescription
bootstrapInitialize an agent with a license
licenseManage agent license
configManage CLI configuration
clusterCluster operations
peersManage cluster peers
servicesManage services
routesManage service routes
credentialsManage API credentials
healthCheck agent health
completionShell completion scripts

API Reference

Documentation for the Arctic HTTP API:

API Overview

Introduction to the HTTP API

Authentication

OAuth2 authentication

Error Codes

API error codes and handling

Endpoints

ResourceDescription
BootstrapAgent initialization
PeersPeer management
ServicesService management
RoutesRoute management
CredentialsCredential management
ClusterCluster operations
HealthHealth checks

Configuration Reference

Documentation for Arctic configuration files and environment variables:

Agent Configuration

Agent settings and data directory

CLI Configuration

CLI config file format

Environment Variables

Environment variable reference

Configuration Not Applied

How to diagnose and fix configuration synchronization issues

CLI Overview

Introduction to the Arctic command-line interface

On this page

Reference DocumentationCLI ReferenceCommandsAPI ReferenceEndpointsConfiguration Reference