Quickstart
1
Check the requirements
- Node.js 20 or newer.
- A Swift/iOS, Kotlin/Android, React Native, Flutter, or Unity app.
- A coding agent, installed and signed in: Claude Code, Codex, OpenCode, or Pi. Any of them works. No agent? See Run without an agent.
2
Install the CLI
npx appstack-cli in place of appstack in every command on this page.3
Get your API key
Copy the key for your app from its project settings in the Appstack dashboard. An app that ships on both iOS and Android has one key per platform.
4
Run it from your app's folder
Commands
integrate
Adds the SDK to your app. It installs the dependency with your existing package manager, adds theconfigure call at your app’s startup, and runs a build or
tests to verify the result. It keeps your API key out of committed source.
review
Checks an existing integration against the docs. It never changes your files, so start here if the SDK is already in your app.--verbose
for the full audit. Without a coding agent, review still runs its
deterministic checks.
upgrade
Moves your app to the latest stable SDK. It updates dependencies and lockfiles, migrates any changed APIs, then verifies the app.--to, and add --dry-run to see the plan first:
API keys
Pass keys through environment variables, or type them into the hidden prompt in the guided walkthrough. The CLI does not accept keys as command-line flags, because flag values can end up in your shell history.- One platform
- iOS and Android
Options
Choose a coding agent
If more than one agent is installed, the CLI asks you to choose one:Run without an agent
--skill prints the full playbook for your project. Paste it into any AI
assistant you already use:
Run in CI
--json runs only the deterministic checks, with no agent, so it works
anywhere Node does:
Advanced
How it works
How it works
The CLI handles project detection, version resolution, safety boundaries, and verification. The Appstack integration knowledge lives in the
appstack-sdk skill from appstack-tech/appstack-skills, with one reference per platform.Skill updates and cache
Skill updates and cache
The CLI downloads the latest skill release, verifies its checksum, and caches it. It checks for a new release at most once every 24 hours, so the first run needs network access.
The default cache is
~/Library/Caches/appstack on macOS, $XDG_CACHE_HOME/appstack (or ~/.cache/appstack) on Linux, and %LOCALAPPDATA%\Appstack on Windows.To delete the cached skill, run:Troubleshooting
No supported coding agent found
No supported coding agent found
Install one of the supported agents, or run the command with
--skill and paste the playbook into your assistant.Multiple coding agents detected
Multiple coding agents detected
Pass
--agent with the one you want to use.An agent is not available
An agent is not available
You passed
--agent with an agent that is not installed. The message lists the agents the CLI found.Multiple apps found
Multiple apps found
Run the command from one app’s folder, or pass
--framework or --install-dir.The Appstack skill is not available yet
The Appstack skill is not available yet
The CLI could not download the skill. Connect to the network and try again, or set
APPSTACK_SKILL_DIR to a local copy.No installed Appstack SDK was detected
No installed Appstack SDK was detected
You ran
upgrade on an app without the SDK. Run appstack integrate instead.The SDK version could not be read
The SDK version could not be read
upgrade found the SDK but not its version. Pass --to <version> to upgrade explicitly.Source
The CLI is open source atappstack-tech/appstack-cli.
