Quick Start
Subcommands
run- Trigger an Xcode Cloud workflow buildstatus- Check the status of an Xcode Cloud build runworkflows- Manage Xcode Cloud workflowsbuild-runs- Manage Xcode Cloud build runsactions- List actions for a build runartifacts- List artifacts for a build runtest-results- List test results for a build runissues- List issues for a build runscm- Manage SCM providers and repositoriesproducts- List Xcode Cloud productsmacos-versions- List available macOS versionsxcode-versions- List available Xcode versions
Commands
xcode-cloud run
Trigger an Xcode Cloud workflow build:--app- App Store Connect app ID (orASC_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 = useASC_TIMEOUTor 30m default)--output- Output format:json,table,markdown--pretty- Pretty-print JSON output
- Specify workflow by name (requires
--app) or by ID (--workflow-id) - Specify branch/tag by name (
--branch) or by ID (--git-reference-id) - Use
--waitto monitor build progress until completion
xcode-cloud status
Check the status of an Xcode Cloud build run:--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 = useASC_TIMEOUTor 30m default)--output- Output format:json,table,markdown--pretty- Pretty-print JSON output
xcode-cloud workflows
Manage Xcode Cloud workflows:list- List Xcode Cloud workflows for an appget- Get details for a workflowrepository- Get the repository for a workflowcreate- Create a workflowupdate- Update a workflowdelete- Delete a workflow
--app- App Store Connect app ID (orASC_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
--id- Workflow ID (required)--output- Output format:json,table,markdown--pretty- Pretty-print JSON output
--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:list- List Xcode Cloud build runs for a workflowbuilds- List builds for a build run
--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:--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:--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:--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:--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:providers list- List SCM providersrepositories list- List SCM repositories for a productgit-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:
