Task-based documentation

Choose the workflow before the command.

Arcane keeps app ownership, shared runtime work, and native toolchains separate. Pick the guide whose boundary matches what you are changing.

Developer paths

Each guide begins with its authority and ends with the exact artifact or evidence it creates.

00

First project

Quick start

Use arcane-os@latest, scaffold one browser app, install it, and let the lockfile record the exact selection.

  • New developers
  • Browser-first
  • 10-minute path
Start here →
AI

One request

TWiN Cloud

Use new AI(), supply your runtime key, and display the complete response. Includes saved-preference migration.

Try TWiN →
TTS

On-device speech

Browser speech

Configure Kokoro, load and unmute, stream audio in exact order, and inspect the selected device.

Try speech →
01

Independent source

External application

Own source, tests, adapters, licensing, and one deterministic release bundle in a separate repository.

  • Private or independent apps
  • Package and bundle
  • Repository delivery
Open guide →
02

Arcane checkout

Integrated workspace

Develop one built-in app or run one exact shared/Core test through the fixed Arcane provider.

  • Built-in applications
  • Shared runtime changes
  • No SDK self-dependency
Open guide →
03

Explicit toolchain

Native builds

Assemble a portable payload, understand the Windows and Mac host-archive requirements, or select checkout-backed Linux and Android providers.

  • One selected platform
  • Separate host artifacts
  • Owned launch and drain
Open guide →
04

Caller-selected models

Native local AI

Prepare explicit runtimes, retain ONNX graph sessions and use complete named tensors or local chat through Core.

Read local AI →
05

Independent audio streams

Speaker diarization

Retain a selected Nemotron model, stream mono audio and observe timed generic speaker labels with owned cancellation.

Read diarization →
06

Application-owned storage

Core preferences

Choose one writable file, preserve complete JSON values and drain accepted writes before the native host exits.

Read preferences →
07

One fetched revision

Git text snapshots

Read complete selected text through a dedicated bare object cache while leaving the application's checkout untouched.

Read snapshots →
08

Explicit generated ownership

Disable source PWA output

Refresh selected documents and retire confirmed SDK-generated files. Use resolvePwaRetirementResponse() in an existing custom host for the disabled worker route, preserving authored workers, other routes and browser saved data.

Read PWA retirement →
NPU

Independent encoder and decoder

Intel NPU Whisper

Select the optional Windows x64 NPU encoder, keep its paired model files together and observe actual readiness through native speech.

Read NPU Whisper →
Core

Application-owned services

Core during development

Compose one application dispatcher and connect a page while rendering and service startup proceed independently.

Read development Core →
Codex

Explicit native session

Codex App Server

Own a selected native process, complete live turns, originating server requests and joined shutdown.

Read native sessions →
MCP

Application-owned tools

MCP STDIO server

Expose authored tools and static resources with complete protocol payloads and cooperative cancellation.

Read MCP STDIO →
Git

Selected repository text

Write, commit and push

Preserve complete selected file content and diagnostics while reporting confirmed and uncertain repository outcomes.

Read repository writing →
Git

Application-selected identity

Git identity defaults

Read separate global, local and effective settings, then select child-only author fields or credential username hints without rewriting Git configuration.

Read Git identity →
Laya

Explicit native activation

Native typed decisions

Score complete state, questions and options with Laya FP32 through the existing ONNX owner, retaining raw scores and every graph output.

Read native decisions →
Core

Same native owners

Service composition

Obtain one dependency-ready service without a renderer, reuse its ONNX runtime and retain prepared model files through actual native cleanup.

Read service composition →
Git

Captured remote and ref

Repository targets

Observe existing checkout configuration and carry a selected target through pull, push and complete text writing. Select longPaths for a new Windows clone; existing repositories and other platforms retain their settings.

Read repository targets →
Theme

Per-instance presentation

Theme choices, labels and styling

Show Light / Dark / System with complete labels. Choose corner radii, label font and group background through host CSS while retaining the shared preference owner, keyboard focus and selected colors during hover. Optional Core service absence stays distinct from genuine failures.

Read theme configuration →
TTS

Complete text and audio

Exact complete speech input

Process every Kokoro content token in ordered engine-capacity segments. Select textFormat:'plain' to preserve supplied speech text through SDK preparation.

Read exact speech input →
Window

Application-selected dimensions

Initial native window size

Choose logical client dimensions and resizing behavior. The matching Windows host fits initial placement to the usable screen while omitted fields keep existing defaults.

Read window configuration →
Core

One application runtime

Shared Core host

Select native.launchContext defaults for ordinary executable launch. Resolve matching state, workspace and shared endpoint locations for native UI and MCP, retaining explicit overrides and independent connections.

Read shared hosting →
Models

One storage owner

Complete model resources

Store the complete selected decision-runtime entry and model resources through DBOPFS, retaining reusable resources, resumable parts and activation-owned cleanup.

Read resource storage →
Data

Committed changes

Live storage subscriptions

Observe successful DBOPFS writes and removals across live application documents while records remain authoritative.

Read storage events →
TTS

Independent preparation

Cancel a cold preview

Release one preparation's activation interest while preserving other active callers and complete saved audio.

Read preparation lifetime →

Boundary check

Which guide should I use?

I need to…WorkspaceGuideResult
Create my first appNew external repositoryQuick startRunning browser app
Keep application source outside ArcaneExternal repositoryExternal appSelected app package or bundle
Change a built-in Arcane appArcane OS checkoutIntegratedOne selected app check/package
Change shared runtime or CoreArcane OS checkoutIntegrated shared scopeOne focused test or canonical check
Produce a portable payload or native development artifactInstalled SDK, or app plus compatible Arcane checkoutNative buildsOne selected target artifact
Publish the SDKCanonical SDK repositoryPublishing guideSelected package, registry release, and consumer notices
Adopt a published SDK releaseConsuming application repositoryConsumer update guideUpdated declaration, lockfile, and managed projections
01

One app

No implicit all-application loop.

02

One target

No inferred format or architecture.

03

One owner

Every background operation surfaces its result.

04

One output

Build only the selected application artifact.