Skip to content

FlightStack CLI - Command Line Interface for Flutter CI/CD

The FlightStack CLI is your command-line interface for managing build agents, viewing builds, and interacting with FlightStack.

Terminal window
# macOS (Homebrew)
brew tap voostack/tap && brew install flightstack
# Linux / macOS (curl)
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 detailed setup instructions.

Terminal window
flightstack <command> [subcommand] [options]
Terminal window
# General help
flightstack --help
# Command-specific help
flightstack agent --help
flightstack agent start --help

login

Authenticate with FlightStack

agent

Manage build agents

logout

Sign out of FlightStack

CommandDescription
flightstack loginAuthenticate with your account
flightstack logoutSign out
flightstack agent listList all agents
flightstack agent show <id>Show agent details
flightstack agent registerRegister this machine
flightstack agent startStart the agent
flightstack agent stopStop the agent
flightstack agent statusShow local agent status
flightstack agent installInstall as startup service
flightstack agent uninstallRemove startup service
flightstack agent update <id>Update agent settings
flightstack agent delete <id>Delete an agent
flightstack updateUpdate CLI to latest version
flightstack configView/modify CLI configuration

Both the CLI and build agent support automatic updates.

Enable automatic updates so you don’t have to manually update:

Terminal window
# Enable auto-update
flightstack config --auto-update true
# Disable auto-update
flightstack config --auto-update false
# Manual update
flightstack update

When auto-update is enabled, the CLI checks for updates once every 24 hours and automatically downloads and applies new versions.

Agents automatically update between jobs by default. This ensures your remote build agents stay up-to-date without manual intervention.

Terminal window
# Disable auto-update for this session
flightstack-agent start --no-auto-update
# Or disable in config.json:
# "autoUpdate": false

When an agent updates, it exits with code 100 and restarts. If you’re using a process manager (systemd, launchd), configure it to restart on this exit code.

OptionDescription
--help, -hShow help
--version, -vShow version

CLI configuration is stored at:

  • macOS/Linux: ~/.flightstack/
  • Windows: %USERPROFILE%\.flightstack\

Files:

  • config.json - User authentication
  • agent.json - Agent registration (if registered)