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
xcode-select --install

​
Installation

Run this command in your terminal: 
curl -sSL https://flowdeck.studio/install.sh | sh
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: 
flowdeck --version
You should see output like: 
1.2.0 (247)

​
License Activation

FlowDeck CLI requires a valid license for full functionality. A license is valid for two (2) machines.

​
Activate Your License

flowdeck license activate YOUR-LICENSE-KEY
Need a new license key? Purchase at flowdeck.studio/cli/purchase.

​
Check License Status

flowdeck 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: 
export FLOWDECK_LICENSE_KEY=YOUR-LICENSE-KEY
flowdeck build --workspace MyApp.xcworkspace --simulator "iPhone 16"

​
Next Steps

Once installed, try these commands: 
# Navigate to your project
cd ~/Projects/MyApp

# Launch interactive mode
flowdeck -i

# Or run commands directly
flowdeck build --workspace MyApp.xcworkspace --scheme myApp --simulator "iPhone 16"
Check the Command Reference for complete documentation of all available commands.

​
Updating

​
Via Built-in Update Command

# Check for updates
flowdeck update --check

# Update to latest version
flowdeck update

​
Via Installer

You can also re-run the installer to update: 
curl -sSL https://flowdeck.studio/install.sh | sh

​
Uninstallation

Before uninstalling, run flowdeck license deactivate to free up your license activation slot.
Remove the FlowDeck binary and configuration: 
# Remove the binary and resources
rm -rf ~/.local/share/flowdeck

# Remove the symlink
rm ~/.local/bin/flowdeck

# Remove configuration files
rm -rf ~/.flowdeck