Skip to main content

Quickstart

This is the fastest path from a local machine to a public Baran HTTPS endpoint.

Use the bundled demo first. It exercises the real deploy path, spends only when you pass --yes-spend, and renders a proof page showing route, Acurast job, Hub registration, job-owned TLS, challenge traffic, and observability state.

1. Install The PROOF CLI​

npm install --global @proof-computer/proof-cli
proof plugins install @proof-computer/proof-cli-baran
proof baran --help

The PROOF CLI currently requires Node.js 22 or newer.

2. Use The Wizard​

Contexts store non-secret metadata and environment variable names under ~/.baran/contexts.json.

proof baran context add mainnet
proof baran context current

context add is interactive. It prompts for Acurast and Polkadot identities, derives addresses from configured seeds, and runs soft balance checks for ACU, Hub native token, and the default accepted Hub asset.

Keep secret values in your shell, password manager, or local secret file. Do not put local signing material or deployment credentials in app repos.

3. Run Preflight​

proof baran preflight --quote

Preflight checks the signed network manifest, control-plane health, Hub RPCs, Acurast identity, Polkadot payment identity, accepted assets, and local deploy runner availability.

Use JSON for automation or support tickets:

proof baran preflight --quote --json

4. Launch The Demo​

Inspect the plan without spending:

proof baran launch-demo --dry-run

Launch when you are ready to spend ACU and the configured Hub payment asset:

proof baran launch-demo --yes-spend

The CLI selects live capacity, creates a temporary project using @proof-computer/baran-express-demo, deploys it to Acurast, funds the Baran quote, waits for registration and route readiness, then prints the public URL.

5. Deploy Your Own Project​

From your app directory:

proof baran init \
  --project hello-api \
  --context mainnet \
  --quote \
  --activate

proof baran preflight --quote
proof baran deploy --yes --dry-run --json
proof baran deploy --yes --duration-minutes 60
proof baran status

proof baran init writes baran.json and .baran/. Baran allocates the public PROOF endpoint during deployment. Deployment state, reports, and workflow snapshots stay under .baran/ in the project directory.

Next Steps​