cli

command module
v3.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 15, 2026 License: BSD-3-Clause Imports: 1 Imported by: 0

README

Arcane Logo

The Official Command Line Client

Go Reference Go Report Card License


Install

This module lives inside the main Arcane repo. To build the CLI locally:

  • go install getarcane.dev/cli/v3@latest

Versions

CLI versions are tagged as cli/vX.Y.Z in the main repo. Use module tags to pin a specific release:

  • go install getarcane.dev/cli/v3@cli/vX.Y.Z

Configure

The CLI stores config in ~/.config/arcanecli.yml.

Create a starter config file (all supported keys):

  • arcane config init
  • arcane config backup (moves current config to ~/.config/arcanecli.yml.bak)

Set the Arcane server URL:

  • arcane config set server-url http://localhost:3552

Authenticate (choose one)

Option A: Device code (OIDC must be enabled for this method, as it uses your external provider.)
  • arcane auth login
Option B: API key
  • arcane config set api-key arc_xxxxxxxxxxxxx

Useful Global Flags

  • --output text|json for output mode (--json is an alias for --output json)
  • --agent <id> to limit one command to a single agent
  • --yes to auto-confirm destructive prompts
  • --no-color to disable ANSI color output
  • --request-timeout <duration> to override HTTP timeout per command

Utilities

  • arcane completion bash|zsh|fish|powershell to generate shell completions
  • arcane doctor to run local CLI diagnostics

Pagination Config

Set global and per-resource list limits in config:

pagination:
  default:
    limit: 25
  resources:
    containers:
      limit: 50
    images:
      limit: 100
    volumes:
      limit: 40
    networks:
      limit: 40

CLI precedence is:

  1. --limit
  2. pagination.resources.<resource>.limit
  3. pagination.default.limit
  4. command built-in default

You can configure limits with:

  • arcane config set default-limit 25
  • arcane config set pagination.resources.containers.limit 50 pagination.resources.images.limit 100

Legacy flag syntax remains supported:

  • arcane config set --default-limit 25
  • arcane config set --resource-limit containers=50 --resource-limit images=100

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL