Contact sales
Try Box
Contact sales
Try Box
Box Box Console

Run your first Box deployment.

Create it, install the licensed package set, start it locally, and complete a safe transaction before binding a real provider.

Quickstart
$ box create acme-commerce
$ box auth --org $BOX_ORG --key $BOX_KEY
$ box install
$ box start acme-commerce 4000 3010

Prerequisites

You need a Box organisation, a licence key, Node.js 22 or later, Docker, and a PostgreSQL database you can discard after evaluation.

Safe by default

A fresh deployment starts with payment, mail, banking, and delivery ports unbound. Nothing external happens until you bind an adapter.

Create and install

Terminal
box create acme-commerce
cd acme-commerce
box auth --org $BOX_ORG --key $BOX_KEY
box install

Authentication binds the organisation and licence. Installation resolves the package manifest once and downloads only the capabilities included in that licence.

Expected output
→ resolving manifest       foundation@2026.9.1
→ pulling from registry    30 packages
→ running migrations       41 applied, 0 pending
✓ installed                30 packages · tier basic

Run locally

Terminal
box start acme-commerce 4000 3010
Expected output
engine    http://localhost:4000
console   http://localhost:3010
payments  port unbound
mailer    port unbound
banking   port unbound

The engine and Merchant Console are now using the same local commerce records. Open the console, create a product, and confirm it appears through the API.

Complete a safe transaction

Terminal
box adapters bind payment test
box seed merchant --name "Acme Market"
box test checkout --amount 2500 --currency NGN

The test adapter records the complete payment and order path without contacting an external rail. Inspect the order before moving to a real integration.

Choose the next path

API and integrationsGenerate a client, call the engine, and subscribe to events. OperationsPrepare hosts, packages, egress, deployment, and upgrades.