OrbitKit CLI

Command-line interface for OrbitKit — App Store compliance hosting for iOS developers. Manage your apps, privacy policies, support pages, app site association files, and deployments from the terminal or CI/CD pipelines.

Installation

npm install -g @orbitkit-io/cli

Requires Node.js 22 or later. The installed command is orbitkit.

Quick Start

# Set your API key (get one at https://orbitkit.io/dashboard → Settings → API Keys)
export ORBITKIT_API_KEY=ok_...

# Verify your key works
orbitkit whoami

# Set a default app ID (optional)
export ORBITKIT_APP_ID=your-app-id

# Deploy your site
orbitkit deploy

Commands

Account

Command	Description
orbitkit whoami	Display authenticated user info

App Management

Command	Description
orbitkit apps list	List all apps
orbitkit apps create <name>	Create a new app
orbitkit apps delete <appId>	Delete an app

Deploy

Command	Description
orbitkit deploy [appId]	Deploy site to production
orbitkit deploy-history [appId]	Show deploy history

Privacy Policy

Command	Description
orbitkit policy get [appId]	Print current policy data
orbitkit policy set [appId] <file>	Upload policy from JSON file

Site Configuration

Command	Description
orbitkit site get [appId]	Print site config
orbitkit site update [appId]	Update name, description, slug, or --search-indexing <true|false>
orbitkit site icon [appId] [file]	Upload app icon
orbitkit site custom-html set [appId]	Set custom homepage HTML (--file or --html)
orbitkit site custom-html get [appId]	Print saved custom homepage HTML
orbitkit site custom-html clear [appId]	Revert to the default hero
orbitkit site domain set [appId] <domain>	Configure custom domain
orbitkit site domain status [appId]	Check DNS/SSL status
orbitkit site domain remove [appId]	Remove custom domain

--search-indexing controls whether search engines may index the hosted pages (default true); TestFlight beta pages are always excluded. A deploy is required for the change to take effect.

Privacy Manifest

Command	Description
orbitkit privacy-manifest get [appId]	Print the PrivacyInfo.xcprivacy config
orbitkit privacy-manifest set [appId] <file>	Upload manifest config from JSON
orbitkit privacy-manifest sync [appId]	Derive the manifest from your privacy-policy wizard answers
orbitkit privacy-manifest download [appId] [-o path]	Download the generated PrivacyInfo.xcprivacy
orbitkit privacy-manifest reference	Apple Required Reason API reference data

Support Page

Command	Description
orbitkit support get [appId]	Print support page config
orbitkit support set [appId] <file>	Upload from JSON file

Data Deletion Page

Command	Description
orbitkit deletion get [appId]	Print deletion page config
orbitkit deletion set [appId] <file>	Upload from JSON file

AASA (Apple App Site Association)

Command	Description
orbitkit aasa get [appId]	Print AASA config
orbitkit aasa set [appId] <file>	Upload AASA from JSON file

Smart App Banner

Command	Description
orbitkit banner get [appId]	Print banner config
orbitkit banner set [appId] <file>	Upload from JSON file

Well-Known Files

Command	Description
orbitkit well-known upload [appId] <file>	Upload well-known file (Sign in with Apple, Apple Pay, Wallet)

TestFlight Landing Page

Command	Description
orbitkit testflight get [appId]	Print TestFlight page config
orbitkit testflight set [appId] <file>	Upload from JSON file

Global Options

Option	Description
--json	Output as JSON (for scripting and piping to jq)
--debug	Enable debug output (HTTP requests, response codes)
-V, --version	Print version
-h, --help	Display help

Environment Variables

Variable	Required	Description
ORBITKIT_API_KEY	Yes	API key (ok_...) from the dashboard
ORBITKIT_APP_ID	No	Default app ID when [appId] is omitted
ORBITKIT_API_ENDPOINT	No	API base URL (default: https://api.orbitkit.io)
NO_COLOR	No	Disable colored output (no-color.org)

CI/CD Usage

GitHub Actions

Use the OrbitKit Deploy action for simple deploys, or the CLI for more complex workflows:

env:
  ORBITKIT_API_KEY: ${{ secrets.ORBITKIT_API_KEY }}
  ORBITKIT_APP_ID: ${{ vars.ORBITKIT_APP_ID }}

steps:
  - run: npx orbitkit policy set privacy-policy.json
  - run: npx orbitkit deploy

Xcode Build Phase

The included scripts/validate-aasa.sh validates your AASA configuration against your app's entitlements at build time. Add it as a Run Script build phase in Xcode. See the AASA documentation for setup details.

Security

• No stored credentials — authentication is via the ORBITKIT_API_KEY environment variable only. No credentials are written to disk.
• Key masking — the API key is never printed in full (displayed as ok_BRTRKF...XXHCG).
• Secret scanning — the ok_ prefix enables GitHub secret scanning auto-detection.

Documentation

• OrbitKit Dashboard — manage your apps and API keys
• API Documentation — full REST API reference
• Privacy Policy Guide — policy schema and field definitions
• AASA Guide — Universal Links, App Clips, Web Credentials setup
• Custom Domains — DNS configuration and SSL provisioning
• GitHub Action — deploy from GitHub Actions

Man Page

A comprehensive man page is included. After installation:

man orbitkit

License

Apache License 2.0 © OrbitKit, Inc.