Arcane OSSDK docs

Published SDK · 0.5.18

Build one Arcane app. Keep every boundary explicit.

Scaffold, develop, test, package, and verify an application in its own repository or inside the Arcane checkout. The CLI, CI, and future graphical tools all use the same headless contract.

Start the quick guide Open the playground

Published packagearcane-os@0.5.18 requires Node.js >=22.23.2. Browser apps need only their project-local SDK; native targets additionally require a compatible Arcane OS checkout.

arcane/1 shared toolchain contract

Published browser quick start

Create one browser app with arcane-os@0.5.18.

The scaffold pins the exact SDK version in the generated project. The browser loop needs no Arcane OS checkout or native provider.

Read every setup step
PowerShell or shell
npx arcane-os@0.5.18 new local-app --path ./local-app --target browser --git
cd local-app
npm install
npm run dev

Documentation by task

Go to the page that answers your question.

The homepage stays short. Detailed workflows, contracts, and evidence live on focused pages with stable links.

01 · Start

Quick start

Use published arcane-os@0.5.18, scaffold one browser app and open the development loop.

About 10 minutes → 02 · Build

Guides

Choose external, integrated, or native development and follow one bounded workflow.

Choose a workflow → 03 · Copy

Hello World

Copy the maintained four-file greeting that applies the Arcane theme and labels a browser or Arcane host.

Open the walkthrough → 04 · Explore

Playground

Build a command and preview a schema-2 app descriptor without sending data or executing a shell.

Configure a command → 05 · Prove

Testing

Understand the four SDK suites and the Vanilla Test lanes for JavaScript, Rust, and C#.

Open the test strategy → 06 · Look up

Reference

Find CLI syntax, output modes, target formats, file contracts, and exact failure boundaries.

Open reference →

Two workspace profiles

Source stays where it belongs.

Both profiles share the same toolchain. The difference is who owns the workspace, runtime source, and release.

External

Independent application repository

Pin the SDK and synchronized runtime, keep proprietary source outside Arcane OS, and publish one deterministic application bundle.

External app guide
Integrated

Arcane OS checkout

Work on one built-in app or one exact shared/Core check without adding an SDK self-dependency to Arcane OS.

Integrated guide

One test contract

Test the language you actually ship.

JavaScriptRustC#

The SDK repository currently pins Vanilla Test 2.1.3 for its JavaScript suite. Vanilla Test also provides native and browser paths for Rust and C#, so native code can keep its tests in its own language instead of copying behavior into a second harness.

See test sets and evidence