CLI Reference

The Shipunk CLI lets you manage apps and releases from your terminal.

Installation

# Global install
npm install -g shipunk

# Or use npx
npx shipunk <command>

Authentication

Authenticate with your API key.

# Interactive prompt
shipunk login

# Or pass key directly
shipunk login --key sk_live_xxxxx

Your API key is stored in ~/.shipunk/config.json.

`shipunk whoami`

Show current authenticated user.

shipunk whoami

`shipunk logout`

Clear stored credentials.

shipunk config clear

App Management

`shipunk apps list`

List all your apps.

shipunk apps list
# or
shipunk apps ls

Output:

Your apps:

  myapp
    https://shipunk.dev/appcast/myapp.xml
    3 releases

  otherapp
    https://shipunk.dev/appcast/otherapp.xml
    1 release

`shipunk apps create`

Create a new app.

shipunk apps create --name "My App" --slug myapp

Options:

--name - Display name for the app
--slug - URL-safe identifier (used in appcast URL)

Release Management

`shipunk release upload`

Upload a new release.

shipunk release upload <file> [options]

Required options:

-a, --app <slug> - App slug
-v, --version <version> - Version number (e.g., 1.2.3)

Optional:

-b, --build <build> - Build number
-n, --notes <notes> - Release notes (inline)
--notes-file <file> - Release notes from file

Examples:

# Basic upload
shipunk release upload MyApp-1.2.0.dmg -a myapp -v 1.2.0

# With build number and notes
shipunk release upload MyApp-1.2.0.dmg \
  -a myapp \
  -v 1.2.0 \
  -b 42 \
  -n "Bug fixes and performance improvements"

# With notes from file
shipunk release upload MyApp-1.2.0.dmg \
  -a myapp \
  -v 1.2.0 \
  --notes-file RELEASE_NOTES.md

`shipunk release list`

List releases for an app.

shipunk release list <app-slug>
# or
shipunk release ls <app-slug>

Output:

Releases for myapp:

  v1.2.0 (42)
    https://cdn.shipunk.dev/releases/xxx/MyApp-1.2.0.dmg
    Feb 22, 2026

  v1.1.0 (38)
    https://cdn.shipunk.dev/releases/xxx/MyApp-1.1.0.dmg
    Feb 15, 2026

Configuration

`shipunk config show`

Show current configuration.

shipunk config show

`shipunk config set`

Set a configuration value.

shipunk config set apiUrl https://custom.shipunk.dev

`shipunk config clear`

Clear all configuration (logout).

shipunk config clear

Environment Variables

You can also configure the CLI with environment variables:

Variable	Description
`SHIPUNK_API_KEY`	API key (alternative to `login`)
`SHIPUNK_API_URL`	Custom API URL

Example:

SHIPUNK_API_KEY=sk_live_xxx shipunk apps list

CLI Reference

On this page