Arcane OSSDK docs

Start here · External browser workspace

From npm to a running browser app.

Use arcane-os@latest to scaffold one repository, install its project-local dependency, and run the generated browser app with an exact lockfile resolution.

arcane-os 0.97.1Node.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.

Current development channel

The scaffold command selects arcane-os@latest. The generated declaration keeps tracking that channel while package-lock.json records the exact version selected for this install.

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@latest new local-app --path ./local-app --target browser --git

Expected: one new Git repository containing index.html and modules/App.js at its root, a schema-2 browser descriptor, tests, and a generated CI workflow.

3. Install the project-local SDK

The scaffold records arcane-os on the latest channel. Install it in the generated repository and let npm record the exact 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. Configure the workspace HTTPS certificate and key using the HTTPS setup guide, or explicitly choose npm run dev -- --http for HTTP source development. Browser secure-context requirements still apply. 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 responseChoose local, native browser or cloud speech and preserve playback order.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.Consumer updatesAdvance the declaration, lockfile, and managed projections together after a release.Command playgroundConfigure another workflow without executing anything.TestingChoose the right test set and language lane.