> ## Documentation Index
> Fetch the complete documentation index at: https://flowdeck.studio/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# What is FlowDeck?

> One CLI for Apple app builds, automation, and project management

FlowDeck CLI is a single command-line interface for iOS/macOS development, replacing `xcodebuild`, `simctl`, `devicectl`, and other Apple tools with a clean, simple workflow for humans and AI agents like Claude Code and Codex.

With `flowdeck`, you can:

* Build, run, test, and debug apps from the terminal
* Automate development and testing with powerful UI automation workflows
* Manage simulators, devices, and live logs in one place
* Handle project management tasks (discover workspaces/schemes, save config, create projects)
* Plug directly into CI/CD with machine-readable JSON output

## Why FlowDeck?

<CardGroup cols={2}>
  <Card title="Terminal-First" icon="terminal">
    Build, run, and test directly from your terminal without switching to Xcode
  </Card>

  <Card title="CI/CD Ready" icon="gears">
    JSON output mode for easy integration with automation pipelines
  </Card>

  <Card title="AI Agent Compatible" icon="robot">
    Designed to work seamlessly with Claude Code, Codex, and other AI assistants
  </Card>

  <Card title="Fast Iteration" icon="bolt">
    Optimized builds with intelligent caching and parallel compilation
  </Card>
</CardGroup>

## Key Features

* **Build & Run** - Compile and launch iOS/macOS apps on simulators or devices
* **Test Execution** - Run unit and UI tests with detailed results
* **Simulator Management** - Boot, shutdown, and manage iOS simulators
* **Device Support** - Deploy and run on physical Apple devices
* **Log Streaming** - Real-time OSLog streaming from running apps
* **JSON Output** - Machine-readable output for automation and AI agents
* **Project Discovery** - Auto-detect workspaces, schemes, and build configurations
* **Project Creation** - Generate new Xcode projects from templates with `flowdeck project create`

## Requirements

<Warning>
  FlowDeck CLI requires macOS with Xcode installed. It does not support Windows or Linux.
</Warning>

* **macOS** 13.0 or later
* **Xcode** 15.0 or later (with command line tools)
* **Apple Silicon Mac**: M1 or later recommended for best performance

## Quick Start

```bash theme={null}
# Install FlowDeck CLI
curl -sSL https://flowdeck.studio/install.sh | sh

# CD to your macOS or iOS project
cd ~/myApp

# Start FlowDeck's interactive mode
flowdeck -i
```

For interactive development with a GUI-like experience, see [Interactive Mode](/cli/interactive).

### Static CLI Usage (Recommended for Agents)

For AI agents and CI/CD, use the `config set` workflow to save project settings:

```bash theme={null}
# 1. Discover project structure
flowdeck context --json

# 2. Initialize with discovered settings
flowdeck config set -w MyApp.xcworkspace -s MyApp -S "iPhone 16"

# 3. Run commands without parameters
flowdeck build    # Uses saved settings
flowdeck run      # Uses saved settings
flowdeck test     # Uses saved settings
flowdeck clean    # Uses saved settings
```

<Tip>
  After running `flowdeck config set`, all subsequent commands use the saved settings automatically. This is the recommended approach for AI agents and CI/CD pipelines.
</Tip>

For complete command documentation, see [Commands Overview](/cli/commands/overview).

```bash theme={null}
# Get help
flowdeck --help

# Show examples for any command
flowdeck build --examples
```

## Getting Help

<CardGroup cols={3}>
  <Card title="Installation Guide" icon="download" href="/cli/install">
    Get FlowDeck CLI installed on your Mac
  </Card>

  <Card title="Command Reference" icon="book" href="/cli/commands/overview">
    Complete documentation for all CLI commands
  </Card>

  <Card title="Support" icon="life-ring" href="/support">
    License activation and support options
  </Card>
</CardGroup>