@otakit/cli

@otakit/cli

Upload and release CLI for OtaKit.

What it does

• reads project config from capacitor.config.*
• authenticates with login or env tokens
• zips the build output
• computes the bundle SHA-256 checksum
• creates an upload session
• uploads the zip directly to object storage
• finalizes the bundle
• optionally releases it to the unnamed channel or a named channel

The normal hosted flow is dashboard-first. Create the app in the dashboard, paste its appId into plugins.OtaKit.appId, then ship:

otakit login
npm run build
otakit upload --release

If you want to create the app from the CLI instead:

otakit register --slug com.example.app

There is no otakit init.

Config model

The CLI reads these files when present:

• capacitor.config.ts
• capacitor.config.js
• capacitor.config.mjs
• capacitor.config.cjs
• capacitor.config.json

Important values:

webDir: "out",
plugins: {
  OtaKit: {
    appId: "app_xxxxxxxx",
    // Optional:
    // channel: "staging",
    // serverUrl: "https://your-server.com/api/v1"
  }
}

Resolution order:

• CLI flags
• environment variables
• capacitor.config.*
• built-in defaults

Main rules:

• appId: --app-id -> OTAKIT_APP_ID -> plugins.OtaKit.appId
• serverUrl: --server -> OTAKIT_SERVER_URL -> plugins.OtaKit.serverUrl -> https://otakit.app/api/v1
• outputDir: upload path arg -> OTAKIT_BUILD_DIR / OTAKIT_OUTPUT_DIR -> webDir
• release channel: --release -> unnamed channel, --release <channel> -> named channel

Auth precedence:

• OTAKIT_TOKEN
• stored token from otakit login

Version precedence:

• --version
• OTAKIT_VERSION
• auto-generated <base>+otk.<commit>.<run>

Release model

• otakit upload upload only
• otakit upload --release upload and release to the unnamed channel
• otakit upload --release staging upload and release to a named channel
• otakit release <bundleId> --channel staging promote an existing bundle later

Releases are append-only. The newest release for (appId, channel) is what devices see on manifest checks.

Common commands

• otakit login
• otakit logout
• otakit whoami
• otakit register --slug <slug>
• otakit upload [path] [--release [channel]]
• otakit release [bundleId] [--channel <channel>]
• otakit releases [--channel <channel> | --base]
• otakit list
• otakit delete <bundleId> --force
• otakit config validate
• otakit config resolve --json
• otakit generate-signing-key

CI

export OTAKIT_TOKEN=otakit_sk_...
export OTAKIT_APP_ID=app_xxxxxxxx
export OTAKIT_BUILD_DIR=out

otakit upload --release

Set OTAKIT_SERVER_URL only for custom or self-hosted servers.

Upload flow

• resolve the build output directory
• require index.html
• zip the output
• compute SHA-256 and size
• call bundles/initiate
• upload directly to object storage
• call bundles/finalize
• optionally call releases

The CLI does not own app creation or channel strategy. It packages the build, uploads it, and optionally promotes it.

Build locally

pnpm --filter @otakit/cli build
pnpm --filter @otakit/cli typecheck
pnpm --filter @otakit/cli dev