Skip to main content
FlowDeck CLI is available for macOS and can be installed with a single command.

​
Prerequisites

Before installing FlowDeck CLI, ensure you have:
1

Recent macOS running on an Apple Silicon or Intel Mac

Windows and Linux are not supported.
  • macOS 13 (Ventura) or higher
2

Xcode

FlowDeck uses Xcode’s internal tools to build and debug your apps.
  • Download from the Mac App Store (16.0 or later)
  • Launch Xcode at least once to install components
  • Accept the license agreement
3

Xcode Command Line Tools

Install the latest command line tools

​
Installation

Run this command in your terminal:
The installer will install to ~/.local/bin by default. If this directory is not in your PATH, it will provide a command to add it.

​
Verify Installation

After installation, verify FlowDeck CLI is working:
You should see output like:

​
License Activation

Standalone terminal use requires a valid CLI license. A license is valid for two (2) machines. A FlowDeck Studio or Teams license activated in the Mac app licenses the CLI on that machine too — the two share one license record, so you do not need a second key to use flowdeck in your own terminal there.

​
Activate Your License

Need a new license key? Purchase at flowdeck.studio/cli/purchase.

​
Check License Status

​
CI/CD Usage

Using your license as an environment variable does not count against your license limit, but the functionality is restricted to CI/CD environments only (GitHub Actions, GitLab CI, CircleCI, Jenkins, etc.).
For CI/CD environments, set the license key as an environment variable instead of activating:

​
Next Steps

Once installed, try these commands:
Check the Command Reference for complete documentation of all available commands.

​
Updating

​
Via Built-in Update Command

​
Via Installer

You can also re-run the installer to update:

​
Uninstallation

Before uninstalling, run flowdeck license deactivate to free up your license activation slot.
Remove the FlowDeck binary and configuration: