Arcane.development.inspect()

This focused page is derived from the mechanically checked full member inventory.

Syntax

Arcane.development.inspect(root)

Parameters

Existing absolute canonical Arcane checkout root

Return value

Promise<{root, runtimeVersion, repository, git, tools, signing, readiness}>

Description

Read-only inspection of an approved development workspace. Developer-only; requires development.read.

Overview

Inspects one explicit canonical Arcane OS checkout and reports developer readiness without changing it. The Developer application uses this snapshot to show repository identity, Git state, external tools, signing readiness, and the allowlisted setup tasks that are ready or need work.

Root and result

Requires development.read and the developer app ID. root must be an existing absolute, non-link directory containing the expected .git, root package, app-building SOP, theme, and canonical machine-bundle markers. Core rejects a different or unsafe layout rather than treating any directory as a development workspace. Git must be installed and the checkout must pass the repository-lineage check; otherwise the call rejects with DEVELOPMENT_GIT_REQUIRED or a more specific repository error.

The result contains {root,runtimeVersion,repository,git,tools,signing,readiness}. readiness.tasks is the authoritative list to display; do not invent setup task IDs or infer readiness from path names alone.

Example

async function inspectSelectedCheckout(root) {
    const inspection = await Arcane.development.inspect(root);
    for (const task of inspection.readiness.tasks) {
        console.log(`${task.label}: ${task.ready ? 'ready' : task.message}`);
    }
    return inspection;
}

const inspection = await inspectSelectedCheckout('C:\\ArcaneOS');
console.log(inspection.repository.bundleVersion);

Reference group

Session, provisioning, diagnostics, and development