Skip to main content

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.

Use config to manage saved runtime project selection state (workspace, scheme, target, configuration).
flowdeck config set is not the same as editing .flowdeck/config.json or .flowdeck/config.local.json. The config command saves per-project runtime defaults, while the .flowdeck/config*.json files are the shared project settings format.

Read Saved Settings

flowdeck config shows command help. Use flowdeck config get to read saved settings for the current project folder.
# Show config command help and subcommands
flowdeck config

# Read saved config for current folder
flowdeck config get

# Read from a different project folder
flowdeck config get -p /path/to/project

# JSON output
flowdeck config get --json

Save Settings

Use flowdeck config set to store workspace/scheme/target defaults:
# iOS Simulator
flowdeck config set -w App.xcworkspace -s MyApp -S "iPhone 16"

# macOS target
flowdeck config set -w App.xcworkspace -s MyApp -D "My Mac"

# Physical device
flowdeck config set -w App.xcworkspace -s MyApp -D "John's iPhone"

# Build configuration
flowdeck config set -w App.xcworkspace -s MyApp -S "iPhone 16" -C Release

# Overwrite existing config
flowdeck config set -w App.xcworkspace -s MyApp -S "iPhone 16" --force

# JSON output
flowdeck config set -w App.xcworkspace -s MyApp -S "iPhone 16" --json

Reset Saved Settings

Use flowdeck config reset to clear saved settings for a project folder:
# Clear saved config for current folder
flowdeck config reset

# Clear saved config for another project folder
flowdeck config reset -p /path/to/project

# JSON output
flowdeck config reset --json

Options (config get)

OptionShortDescription
--project <path>-pProject directory (defaults to current)
--json-jOutput as JSON
--examples-eShow usage examples

Options (config set)

OptionShortDescription
--project <path>-pProject directory (defaults to current)
--workspace <path>-wPath to .xcworkspace or .xcodeproj (required)
--scheme <name>-sScheme name
--configuration <name>-CBuild configuration (Debug/Release)
--simulator <name>-SSimulator name or UDID
--device <name>-DDevice name or UDID (use “My Mac” for macOS)
--force-fOverwrite an existing saved config
--json-jOutput as JSON
--examples-eShow usage examples

Options (config reset)

OptionShortDescription
--project <path>-pProject directory (defaults to current)
--json-jOutput as JSON
--examples-eShow usage examples

JSON Output (config set)

{
  "schema": "flowdeck.config",
  "schemaVersion": "1.0.0",
  "success": true,
  "message": "Project configuration saved",
  "workspace": "App.xcworkspace",
  "scheme": "MyApp",
  "target": "iPhone 16",
  "targetType": "simulator",
  "configuration": "Debug"
}

JSON Output (config reset)

{
  "schema": "flowdeck.config",
  "schemaVersion": "1.0.0",
  "success": true,
  "message": "Project configuration reset",
  "projectPath": "/path/to/project",
  "cleared": true
}