CLI Reference
CLI Tool
Command-line interface for automating app store workflows in CI/CD pipelines.
CI/CD Ready
Designed for GitHub Actions, GitLab CI, and more
Cross-Platform
Works on macOS, Linux, and Windows
Secure
API key in environment variable
Installation
Install globally with npm:
Terminalbash
npm install -g @appstorecopilot/cli
Or use npx without installing:
Terminalbash
npx @appstorecopilot/cli --help
Quick Start
Terminalbash
# 1. Authenticateasc auth login --key $ASC_API_KEY# 2. Select a projectasc projects use proj_abc123# 3. Pull existing metadataasc pull --store both# 4. Translate to new languagesasc translate --from en-US --to es-ES,fr-FR,de-DE# 5. Push changesasc push --store both
Authentication
The CLI supports two authentication methods:
Environment Variable (Recommended for CI/CD)
Terminalbash
export ASC_API_KEY=asc_live_xxxxxxxxxxasc projects list
Interactive Login
Terminalbash
asc auth login# Enter API key when prompted# Key is stored securely in system keychain
CI/CD Best Practice
Always use the ASC_API_KEY environment variable in CI/CD pipelines. Store it as a secret in your CI system.
Commands
asc authManage authenticationasc projectsProject managementasc translateTranslate metadataasc pullPull from storesasc pushPush to storesasc publishPublish to storesasc statusCheck usage statsGlobal Options
| Option | Description |
|---|---|
--help, -h | Show help for a command |
--version, -v | Show CLI version |
--json | Output in JSON format (for scripting) |
--quiet, -q | Suppress non-essential output |
--verbose | Show detailed debug output |
Exit Codes
The CLI uses standard exit codes for CI/CD integration:
| Code | Meaning |
|---|---|
0 | Success |
1 | General error |
2 | Authentication error |
3 | API error |