Arcane OSSDK docs

Start here · External browser workspace

From npm to a running browser app.

Use published arcane-os@0.5.18 to scaffold one repository, install its exact project-local dependency, and run the generated browser app.

arcane-os 0.5.18Node.js >=22.23.2About 10 minutes

1. Check the prerequisites

Use Node.js 22.23.2 or newer, npm, and Git. The browser quick start needs no Arcane OS checkout or native provider.

Published package

This guide pins arcane-os@0.5.18 explicitly so the scaffold and installed project use the same released SDK.

2. Scaffold one browser application

Name the published package and the browser target explicitly. Native targets are a separate provider-paired workflow.

PowerShell or shell
npx arcane-os@0.5.18 new local-app --path ./local-app --target browser --git

Expected: one new Git repository containing apps/local-app/, a schema-2 browser descriptor, tests, and a generated CI workflow.

3. Install the project-local SDK

The scaffold records exact arcane-os version 0.5.18. Install it in the generated repository and let npm record the dependency resolution in package-lock.json.

generated local-app repository
cd local-app
npm install

4. Run the browser app

The generated scripts use the SDK pinned by the app lockfile. Development serves your saved source. Run tests or checks only when you explicitly select them.

generated local-app repository
npm run dev
Check the terminal and browser.

The development command acknowledges first, prints the loopback URL, and owns its server until you cancel it.

Where to go next

Your first TWiN requestSupply a runtime key, send Hello, and display the complete response.Your first spoken responseConfigure on-device Kokoro, inspect WebGPU or WASM, and stream exact-order audio.Hello WorldCopy the maintained four-file greeting that applies the Arcane theme and labels a browser or Arcane host.External app guidePackage, bundle, and publish an independently owned app.Command playgroundConfigure another workflow without executing anything.TestingChoose the right test set and language lane.