Skip to main content

CLI Reference

This document provides a comprehensive reference for all Source Push CLI commands.

App Management​

Create an App​

srcpush app add <appName>

Options:

  • --platform - Specify platform (ios/android)
  • --deployments - Comma-separated list of deployments to create

List Apps​

srcpush app ls

Options:

  • -k, --keys - Show deployment keys
  • --platform - Filter by platform

Remove an App​

srcpush app rm <appName>

Rename an App​

srcpush app rename <currentName> <newName>

Deployment Management​

Add Deployment​

srcpush deployment add <appName> <deploymentName>

Options:

  • -k, --key <key> - Specify deployment key

List Deployments​

srcpush deployment ls <appName>

Options:

  • -k, --keys - Show deployment keys

Remove Deployment​

srcpush deployment rm <appName> <deploymentName>

Rename Deployment​

srcpush deployment rename <appName> <currentName> <newName>

Release Management​

Release Update​

srcpush release-react <appName> <platform>

Options:

  • -d, --deployment <name> - Deployment name (default: Staging)
  • -t, --target-binary-version <version> - Target binary version(s)
  • -m, --mandatory - Make update mandatory
  • -x, --disabled - Make update disabled
  • -r, --rollout <percentage> - Percentage of users to roll out to
  • --description <description> - Update description
  • -k, --private-key-path <path> - Path to private key for code signing

Promote Update​

srcpush promote <appName> <sourceDeployment> <destDeployment>

Options:

  • --description <description> - Override description
  • --disabled - Disable the promoted release
  • --mandatory - Make update mandatory
  • --rollout <percentage> - Percentage of users to roll out to
  • --target-binary-version <version> - Override target binary version

Rollback Update​

srcpush rollback <appName> <deploymentName>

Options:

  • --target-release <label> - Specific release to roll back to

Collaborator Management​

Add Collaborator​

srcpush collaborator add <appName> <email>

List Collaborators​

srcpush collaborator ls <appName>

Remove Collaborator​

srcpush collaborator rm <appName> <email>

Access Key Management​

Create Access Key​

srcpush access-key add <keyName>

Options:

  • --ttl <duration> - Time-to-live for the key (e.g., "30d", "2h")

List Access Keys​

srcpush access-key ls

Remove Access Key​

srcpush access-key rm <keyName>

Session Management​

Login​

srcpush login

Options:

  • --accessKey <key> - Login with access key
  • --proxy <url> - Use proxy for connection

Logout​

srcpush logout

List Sessions​

srcpush session ls

Remove Session​

srcpush session rm <machineName>

Debugging​

View Debug Logs​

srcpush debug <platform>

Options:

  • --proxy <url> - Use proxy for connection

Common Options​

These options are available for most commands:

  • --help - Show help information
  • --version - Show CLI version
  • --debug - Enable debug output
  • --proxy <url> - Use proxy for connection
  • --no-proxy - Disable proxy

Environment Variables​

The CLI respects the following environment variables:

  • SRCPUSH_SERVER_URL - Custom server URL
  • SRCPUSH_ACCESS_KEY - Pre-configured access key
  • SRCPUSH_PROXY - Proxy server URL
  • SRCPUSH_NO_PROXY - Disable proxy

Exit Codes​

  • 0 - Success
  • 1 - General error
  • 2 - Invalid arguments
  • 3 - Network error
  • 4 - Authentication error

See Also​