Skip to content

CLI Overview

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 (Scoop)
scoop bucket add voostack https://github.com/voostack/scoop-bucket
scoop install flightstack
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
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)