Skip to content
FlightStack Docs
Sign in Start free

FlightStack CLI — overview

The FlightStack CLI is the terminal-side surface for the whole product. It runs the same APIs the dashboard uses, plus a handful of agent-side commands that exist only on the CLI (installation, the upgrade flow, the doctor).

Terminal window
# macOS / Linux (Homebrew)
brew tap voostack/flightstack-cli-tap && brew install flightstack
# Linux / macOS (one-liner)
curl -fsSL https://get.flightstack.dev | bash
# Windows (PowerShell)
Invoke-WebRequest -Uri "https://github.com/voostack/flightstack-releases/releases/latest/download/flightstack-windows-x64.zip" -OutFile "flightstack.zip"

See the installation guide for verification and uninstall instructions.

Terminal window
flightstack <command> [subcommand] [options]
Terminal window
flightstack --help # all commands
flightstack agent --help # subcommands of a command
flightstack agent start --help # flags for a specific subcommand

Auth & session

login · logout · config · doctor · update — see Authentication.

Build agents

flightstack agent <subcommand> — register, start, stop, status, install, doctor, upgrade. See Agent commands.

Repositories

flightstack repo --list · --available · --connect · --sync · --disconnect. See Repository commands.

Pipelines & runs

flightstack pipeline lint <file> · flightstack logs <run-id>. See Pipeline commands.

CommandWhat it does
flightstack loginOAuth login through your browser
flightstack logoutSign out and clear local credentials
flightstack configShow or change CLI configuration
flightstack doctorDiagnose CLI environment issues (Flutter, Dart, Xcode, network)
flightstack updateManually update the CLI binary
flightstack statusQuick status of your account, agents, and recent builds
flightstack orgList and inspect organizations you belong to
flightstack repo [flags]List, connect, sync, or disconnect connected repositories
flightstack workflowList and inspect workflows (legacy pipeline definitions)
flightstack pipeline lint <file>Validate a pipeline YAML file against the FlightStack spec
flightstack logs <run-id>Print or tail logs for a pipeline run
flightstack buildInspect build history and individual build runs
flightstack templateBrowse marketplace templates
flightstack publisherManage publisher profile (for those who ship marketplace steps)
flightstack agent listList build agents on your account
flightstack agent show <id>Show details for an agent
flightstack agent registerRegister this machine as a build agent
flightstack agent startStart the agent (foreground or daemon)
flightstack agent stopStop the running agent
flightstack agent statusLocal agent status (PID, log path)
flightstack agent installInstall as a startup service (launchd / systemd)
flightstack agent uninstallRemove the startup service
flightstack agent update <id>Update an agent’s server-side settings (name, org)
flightstack agent upgradeUpgrade the agent binary to the latest release
flightstack agent delete <id>Delete / unregister an agent
flightstack agent doctorDiagnose agent-side issues (service, binary, PID, API connectivity)
FlagDescription
--help, -hShow help for the current command.
--verbose, -vEnable verbose logging.
--versionPrint the CLI version (no abbreviation).

The CLI checks for updates daily and self-installs when autoUpdate is enabled (default: enabled). Toggle:

Terminal window
flightstack config --auto-update true # opt in
flightstack config --auto-update false # opt out
flightstack update # manual check now

The build agent ships separately. Upgrade the agent binary explicitly with:

Terminal window
flightstack agent upgrade # install latest
flightstack agent upgrade --check # check only

If you registered the agent as a service, restart it after upgrade:

Terminal window
flightstack agent stop && flightstack agent start --daemon

All CLI state lives in ~/.flightstack/ (macOS / Linux) or %USERPROFILE%\.flightstack\ (Windows). See CLI configuration for the file layout, fields, and supported environment-variable overrides.