Hyperscale quickstart

Install the CLI, create an account, describe a business and run a test customer through it. Then call the same Product over HTTP, from the TypeScript SDK and from an agent. Every client calls the same operations and reads the same state. The CLI takes money in major units, like 300.50; the HTTP API and MCP take minor-unit strings, like "30050".

People read the docs in the console at https://console.hyperscale0.ai/docs/. The console runs the same loop without a terminal: describe the Product to the Architect and save it, make a sandbox key on the Keys page under Connect, send one request from your client and read the result on the Logs page.

1. Install the CLI

Node 22 or later. Without the install, bunx @hyperscale0/cli@latest <command> runs the same commands.

npm i -g @hyperscale0/cli

2. Create your account

auth signup makes the account and its company without a browser. It asks for a password, emails a six-digit code to the address, then asks for the code. The code works for 15 minutes and five tries.

hyperscale auth signup --name "Maya Lindqvist" --email [email protected] --company "Lumen"

A script or an agent pipes the password on stdin. A person who reads that mailbox gives the code to a second run, which takes the same password, since the code works only with the password that asked for it:

hyperscale auth signup --name "Maya Lindqvist" --email [email protected] --company "Lumen" < password-file
hyperscale auth signup --email [email protected] --code 123456 < password-file

Already have an account? hyperscale auth login signs in through the browser. Sign in covers every path.

3. Describe your business

Say what you sell and who pays whom. The Architect drafts and checks the Product, and --yes saves and selects it. The Architect is free. The second line keeps the Product id for step 6; it needs jq.

hyperscale architect chat --brief "Desks by the month: SAR 1,200, a SAR 500 deposit, SAR 50 late fee" --yes
PRD=$(hyperscale product show --json | jq -r .productId)

4. Run a test customer through it

In an empty folder, init writes the Product's files and day.json. The scenario funds a new test customer with SAR 10,000.00 of sandbox money and walks it to its first payment. Each run adds another customer.

hyperscale init
hyperscale scenario run day.json

5. Change it

Edit product.hsx, check it, save the plan, read it, then apply that plan.

hyperscale hsx check product.hsx
hyperscale hsx plan --json > plan.json
hyperscale hsx apply --plan-file plan.json --yes

6. Call the HTTP API

Make a sandbox Product key, then call any route with it. The key prints once, so the first line keeps it. HTTP API walks one customer through money with curl.

KEY=$(hyperscale key create --json | jq -r .shown_once)
curl "https://hyperscale0.ai/v1/customers?productId=$PRD" -H "Authorization: Bearer $KEY"

7. Use the TypeScript SDK

Call the Product from your app with the same key. TypeScript SDK generates your Core's types, with a quickstart for its first action.

npm i @hyperscale0/sdk

8. Connect an agent

Add the MCP server and approve it in the browser. A coding agent in a terminal gets its own sandbox login with hyperscale agent setup. Connect an agent with MCP covers every client.

claude mcp add --transport http hyperscale https://hyperscale0.ai/v1/mcp

CLI exit codes

A script branches on the exit code. hyperscale help --json prints the same table.