Agent Commands

Agent Commands

Manage build agents with the flightstack agent command.

flightstack agent <subcommand> [options]

Commands

list

List all registered agents:

flightstack agent list

Output:

Build Agents (2):
────────────────────────────────────────────────────────────

Mac-Mini-Office
  ID: a1b2c3d4-e5f6-...
  Status: 🟢 Online
  Scope: 🌐 Public
  Platform: macOS
  Capabilities: iOS, Android, Web
  Builds: 127 total, 119 successful

Linux-CI-Server
  ID: f7g8h9i0-j1k2-...
  Status: 🔴 Offline
  Scope: 🔒 Private (Acme Corp)
  Platform: Linux
  Capabilities: Android, Web
  Builds: 45 total, 42 successful

show

Show detailed information about an agent:

flightstack agent show <agent-id>

Output:

Agent Details
────────────────────────────────────────────────────────────
Name: Mac-Mini-Office
ID: a1b2c3d4-e5f6-...
Status: 🟢 Online
Scope: 🌐 Public

System:
  OS: macOS 14.2
  Xcode: 15.1
  Flutter: 3.16.5
  Dart: 3.2.3

Capabilities:
  iOS: ✓
  Android: ✓
  Web: ✓

Statistics:
  Total Builds: 127
  Successful: 119
  Failed: 8
  Avg Build Time: 4.2 min

register

Register this machine as a build agent:

flightstack agent register [options]

Options:

Flag	Description
--name, -n	Agent name (default: hostname)
--org, -o	Organization ID for private agent

Examples:

# Register with default name
flightstack agent register

# Custom name
flightstack agent register --name "iOS-Builder"

# Private to an organization
flightstack agent register --org abc123-def456

start

Start the build agent:

flightstack agent start [options]

Options:

Flag	Description
--daemon, -D	Run in background
--debug, -d	Enable debug logging

Examples:

# Foreground (interactive)
flightstack agent start

# Background (daemon)
flightstack agent start --daemon

stop

Stop a running agent:

flightstack agent stop

status

Show local agent status:

flightstack agent status

install

Install agent as a startup service:

flightstack agent install

The agent will start automatically on boot/login.

uninstall

Remove startup service:

flightstack agent uninstall

update

Update an agent’s settings:

flightstack agent update <agent-id> [options]

Options:

Flag	Description
--name, -n	New name
--org, -o	Move to organization
--public, -p	Make public (clear org)

Examples:

# Rename
flightstack agent update abc123 --name "New Name"

# Make public
flightstack agent update abc123 --public

# Assign to organization
flightstack agent update abc123 --org org-id-here

delete

Delete/unregister an agent:

flightstack agent delete <agent-id>

Aliases: unregister

You’ll be prompted for confirmation. If deleting the local agent, configuration files are also removed.