Arcane OSSDK docs

Arcane OS checkout

Work inside Arcane without widening the test boundary.

The SDK source CLI can select one built-in app or one exact shared test. The Arcane checkout remains authoritative and never depends on the SDK package it is helping to develop.

Profile: integratedDefault unit: one appShared scope: explicit

1. Select the checkout explicitly

Run the CLI from the SDK source tree and point it at the Arcane OS checkout. This avoids adding a self-referential SDK dependency to Arcane.

From the SDK repository
node ./bin/arcane.mjs doctor --workspace "../Arcane OS"
node ./bin/arcane.mjs targets --workspace "../Arcane OS"
Profile detection is evidence-based.

The selected workspace must have the Arcane repository markers and layout. A directory name alone does not make it integrated.

2. Keep application work app-scoped

Name the built-in app for development, tests, checks, packaging, and browser run. This is the normal integrated loop.

One built-in app
node ./bin/arcane.mjs dev --workspace "../Arcane OS" --app calculator
node ./bin/arcane.mjs test --workspace "../Arcane OS" --app calculator
node ./bin/arcane.mjs check --workspace "../Arcane OS" --app calculator
node ./bin/arcane.mjs package --workspace "../Arcane OS" --app calculator
node ./bin/arcane.mjs run --workspace "../Arcane OS" --app calculator --target browser

Expected: the selected app and its declared shared payloads are validated; unrelated applications do not join the loop implicitly.

3. Enter shared scope deliberately

A shared runtime or Core change must name one repository-relative .test.mjs file, or use the Arcane repository's canonical full check when the change is ready for broad validation.

One focused shared test
node ./bin/arcane.mjs test --workspace "../Arcane OS" --scope shared --test-file test/path/to/exact.test.mjs

# Broad gate only when justified
node ./bin/arcane.mjs check --workspace "../Arcane OS" --scope shared
Shared scope is integrated-only.

An external application repository cannot request Arcane root, shared, or native test suites. Move the work to the authoritative Arcane checkout instead.

4. Keep integrated native roots identical

For a native build in the Arcane repository, --workspace and --arcane-root must resolve to the same checkout. Select one descriptor-declared target, and place --output-root outside that checkout.

Integrated native example
node ./bin/arcane.mjs build --workspace "../Arcane OS" --app calculator --target windows-x64 --arcane-root "../Arcane OS" --output-root "../arcane-native-output"

See the native build guide before attempting run, signing, or cross-platform output.

5. Handoff with the narrow result

Report the selected workspace, app or exact test file, target, and artifact or evidence path. Never describe an app-only check as proof that every built-in app or native provider passed.

  • One absolute workspace boundary is known.
  • One app or one shared test file is named.
  • One target is explicit.
  • The broad canonical check runs before repository delivery.