Markdown

Quickstart

Ship a first release in about ten minutes. You need an account, the CLI, and a built artifact.

1. Install the CLI

bash
npm install -g stacklift
stacklift --version
The CLI is not on npm yet. Until the first release, install the build you were given for early access.

2. Sign in

bash
stacklift login

This asks for your email and password once, creates a revocable personal access token named after your machine, stores it in ~/.config/stacklift/credentials.json (mode 0600) and discards the password. In CI, set STACKLIFT_TOKEN instead.

Using GitHub or Google sign-in? Create a token under API Keys → Personal access tokens and run stacklift login --token slp_….

3. Connect your app

bash
cd my-app
stacklift init

init looks at your files, detects the stack (for example React Native from package.json), tells you how mature support for that stack is, creates a project (or links an existing one) and writes `stacklift.yaml`.

The project's public key and CI secret key are printed once. Store them.

4. Create a release

bash
stacklift release create \
  --version 1.0.0 \
  --runtime-version 1.0.0 \
  --artifact android:js-bundle:./dist/android.zip \
  --channel staging

What happens:

  1. Every artifact is hashed locally (streamed — files are never loaded fully into memory).
  2. The release is created as a draft.
  3. Each artifact is declared (size + SHA-256) and uploaded directly to object storage through a short-lived signed URL.
  4. The server re-reads the stored bytes, recomputes the checksum, signs the artifact with your project's Ed25519 key and marks it verified. A mismatch fails the release.
  5. Once every platform has a verified artifact the release becomes Ready, and --channel deploys it.

5. Roll out gradually

bash
stacklift release promote 1.0.0 --to production --percentage 5
stacklift status
stacklift rollout advance --channel production
stacklift rollout set 50 --channel production

Percentages only go up. Nothing expands automatically unless you opt in with --auto-expand --interval <minutes>.

6. Roll back

bash
stacklift release rollback --channel production --to 0.9.0 --reason "crash on launch"

The CLI (and the API) refuse a rollback to a release that devices can't run: different runtime version, missing platform, unverified artifact, or an artifact kind that can't be reverted through Stacklift.

7. Wire the SDK into your app

See the SDK guide. The app embeds the public key and pins your project's signing public key.