Quickstart

Five minutes from a build file on your machine to an install link and QR code on a tester's phone.

1. Install the CLI

npm install -g @buildtree/cli

The binary on your PATH is buildtree. Requires Node 18.19 or later. Node 20 or 22 is recommended.

2. Sign in

buildtree login

Authorise the session in the browser when prompted.

3. Upload a build

buildtree upload ./app.apk

The CLI prompts for:

Project. Pick an existing one or create a new one inline.
Environment. A short label such as dev, staging, or prod.
Branch. Optional. Skip to mark the build as the environment's checkpoint.

The install URLs and a QR code are printed on completion.

4. Share the install URL

Two URLs are produced per upload:

Pinned: locked to this exact build.
Folder: always serves the latest for the environment and branch.

5. Run it from CI

# Feature branch (pre-merge QA build)
buildtree upload ./app.apk \
  --project acme \
  --env dev \
  --branch "$GITHUB_HEAD_REF"

# Develop checkpoint (no --branch, after merge)
buildtree upload ./app.apk \
  --project acme \
  --env dev

Use an API token from the dashboard and set BUILDTREE_TOKEN. See the GitHub Actions guide for a ready-to-copy workflow that handles both cases with a shell conditional, and the pre-merge QA workflow for why the checkpoint vs branch distinction matters.

Last updated September 27, 2026

PreviousIntroduction Next Concepts