Arcane OS Docs Development only

Reference

Arcane.requirements.list()

Lists installation requirements.

  • Reference

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

Syntax

Arcane.requirements.list()

Parameters

None

Return value

Promise<requirement[]>

Description

Lists installation requirements.

Overview

Arcane.requirements.list() returns all current Core installation requirement records. It requires requirements.read, takes no parameters, changes nothing, and emits no event. The result is a bare array, not a wrapper object.

Result

The array currently contains ollama, renderer, and session-control. Renderer and session-control records have exactly id, name, minimumVersion, required, installable, description, ready, blocking, status, version, executable, message, platform, and adapter.

The Ollama record additionally has requiredFor, requiredScope, detection, and globalInstall. detection separates machine-wide and user-scoped observations; globalInstall is exactly {available, status, action, requiresElevation, provider, reason}. Ollama is optional for base Arcane OS, but required before local AI. Paths and process observations are local machine data and should not be logged wholesale.

Errors and recovery

METHOD_NOT_ALLOWED means the app lacks requirements.read. A record whose ready is false includes a human-facing message; only blocking: true blocks base installation. Refresh the list after the operator resolves a prerequisite rather than modifying the returned record.

Example

const requirements = await Arcane.requirements.list();

for (const requirement of requirements) {
    console.log(
        requirement.name,
        requirement.status,
        requirement.blocking
    );
}

Reference group

Platform, installation, users, and system

Repository and reviewed source access