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. Authenticate
asc auth login --key $ASC_API_KEY
# 2. Select a project
asc projects use proj_abc123
# 3. Pull existing metadata
asc pull --store both
# 4. Translate to new languages
asc translate --from en-US --to es-ES,fr-FR,de-DE
# 5. Push changes
asc push --store both

Authentication

The CLI supports two authentication methods:

Environment Variable (Recommended for CI/CD)

Terminalbash
export ASC_API_KEY=asc_live_xxxxxxxxxx
asc projects list

Interactive Login

Terminalbash
asc auth login
# Enter API key when prompted
# Key is stored securely in system keychain

Commands

Global Options

OptionDescription
--help, -hShow help for a command
--version, -vShow CLI version
--jsonOutput in JSON format (for scripting)
--quiet, -qSuppress non-essential output
--verboseShow detailed debug output

Exit Codes

The CLI uses standard exit codes for CI/CD integration:

CodeMeaning
0Success
1General error
2Authentication error
3API error