Skip to main content

xcode-cloud

Trigger and monitor Xcode Cloud workflows and builds
Trigger and monitor Xcode Cloud workflows, build runs, and CI integration.

Quick Start

Subcommands

  • run - Trigger an Xcode Cloud workflow build
  • status - Check the status of an Xcode Cloud build run
  • workflows - Manage Xcode Cloud workflows
  • build-runs - Manage Xcode Cloud build runs
  • actions - List actions for a build run
  • artifacts - List artifacts for a build run
  • test-results - List test results for a build run
  • issues - List issues for a build run
  • scm - Manage SCM providers and repositories
  • products - List Xcode Cloud products
  • macos-versions - List available macOS versions
  • xcode-versions - List available Xcode versions

Commands

xcode-cloud run

Trigger an Xcode Cloud workflow build:
Flags:
  • --app - App Store Connect app ID (or ASC_APP_ID)
  • --workflow - Workflow name to trigger
  • --workflow-id - Workflow ID to trigger (alternative to --workflow)
  • --branch - Branch or tag name to build
  • --git-reference-id - Git reference ID to build (alternative to --branch)
  • --wait - Wait for build to complete
  • --poll-interval - Poll interval when waiting (default: 10s)
  • --timeout - Timeout for Xcode Cloud requests (0 = use ASC_TIMEOUT or 30m default)
  • --output - Output format: json, table, markdown
  • --pretty - Pretty-print JSON output
Notes:
  • Specify workflow by name (requires --app) or by ID (--workflow-id)
  • Specify branch/tag by name (--branch) or by ID (--git-reference-id)
  • Use --wait to monitor build progress until completion

xcode-cloud status

Check the status of an Xcode Cloud build run:
Flags:
  • --run-id - Build run ID to check (required)
  • --wait - Wait for build to complete
  • --poll-interval - Poll interval when waiting (default: 10s)
  • --timeout - Timeout for Xcode Cloud requests (0 = use ASC_TIMEOUT or 30m default)
  • --output - Output format: json, table, markdown
  • --pretty - Pretty-print JSON output

xcode-cloud workflows

Manage Xcode Cloud workflows:
Subcommands:
  • list - List Xcode Cloud workflows for an app
  • view - View details for a workflow
  • repository - Get the repository for a workflow
  • create - Create a workflow
  • update - Update a workflow
  • delete - Delete a workflow
Flags (list):
  • --app - App Store Connect app ID (or ASC_APP_ID)
  • --limit - Maximum results per page (1-200)
  • --next - Fetch next page using a links.next URL
  • --paginate - Automatically fetch all pages
  • --output - Output format: json, table, markdown
  • --pretty - Pretty-print JSON output
Flags (view):
  • --id - Workflow ID (required)
  • --output - Output format: json, table, markdown
  • --pretty - Pretty-print JSON output
Flags (create/update):
  • --file - Path to workflow JSON payload (required)
  • --id - Workflow ID (required for update)
  • --output - Output format: json, table, markdown
  • --pretty - Pretty-print JSON output

xcode-cloud build-runs

Manage Xcode Cloud build runs:
Subcommands:
  • list - List Xcode Cloud build runs for a workflow
  • builds - List builds for a build run
Flags:
  • --workflow-id - Workflow ID to list build runs for
  • --run-id - Build run ID to list builds for
  • --limit - Maximum results per page (1-200)
  • --next - Fetch next page using a links.next URL
  • --paginate - Automatically fetch all pages
  • --output - Output format: json, table, markdown
  • --pretty - Pretty-print JSON output

xcode-cloud actions

List actions for a build run:
Flags:
  • --run-id - Build run ID (required)
  • --limit - Maximum results per page (1-200)
  • --next - Fetch next page using a links.next URL
  • --paginate - Automatically fetch all pages
  • --output - Output format: json, table, markdown
  • --pretty - Pretty-print JSON output

xcode-cloud artifacts

List artifacts for a build run:
Flags:
  • --run-id - Build run ID (required)
  • --limit - Maximum results per page (1-200)
  • --next - Fetch next page using a links.next URL
  • --paginate - Automatically fetch all pages
  • --output - Output format: json, table, markdown
  • --pretty - Pretty-print JSON output

xcode-cloud test-results

List test results for a build run:
Flags:
  • --run-id - Build run ID (required)
  • --limit - Maximum results per page (1-200)
  • --next - Fetch next page using a links.next URL
  • --paginate - Automatically fetch all pages
  • --output - Output format: json, table, markdown
  • --pretty - Pretty-print JSON output

xcode-cloud issues

List issues for a build run:
Flags:
  • --run-id - Build run ID (required)
  • --limit - Maximum results per page (1-200)
  • --next - Fetch next page using a links.next URL
  • --paginate - Automatically fetch all pages
  • --output - Output format: json, table, markdown
  • --pretty - Pretty-print JSON output

xcode-cloud scm

Manage SCM providers and repositories:
Subcommands:
  • providers list - List SCM providers
  • repositories list - List SCM repositories for a product
  • git-references list - List Git references for a repository

Workflow Examples

Trigger and Monitor Build

CI Integration

Timeouts

Xcode Cloud operations can take a long time. Use the --timeout flag or set ASC_TIMEOUT to increase the request timeout:
Or use the flag directly: