Arcane OS Docs Development only

Reference

Arcane.environment.get()

Gets one configured entry. This is the deliberate plaintext-reveal operation: a protected entry's real value crosses the native bridge to the authorized renderer. Requires the separate environment.protected.read capability.

  • Reference

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

Syntax

Arcane.environment.get(name)

Parameters

name: environment-variable name

Return value

Promise<{entry}>

Description

Gets one configured entry. This is the deliberate plaintext-reveal operation: a protected entry's real value crosses the native bridge to the authorized renderer. Requires the separate environment.protected.read capability.

Overview

Reads one configured environment entry, including the real value when the entry is protected. This deliberate plaintext-reveal operation is restricted to the Vault application with the separate environment.protected.read capability. On Android the entry belongs to the calling application's private profile, and requesting PATH rejects with ENVIRONMENT_PATH_UNSUPPORTED.

Do not log, persist, transmit, or place the returned value in diagnostics. Keep it only for the immediate user-authorized workflow that required the reveal.

Input, result, and errors

Names must begin with a letter or underscore and then contain only letters, numbers, underscores, periods, or hyphens, up to 128 characters. The promise resolves to {entry} using the entry shape described above. Missing entries reject with ENVIRONMENT_ENTRY_NOT_FOUND; invalid names reject before native dispatch.

Example

async function revealEntryForCurrentInteraction(name) {
    const { entry } = await Arcane.environment.get(name);
    return entry.value;
}

const value = await revealEntryForCurrentInteraction('ARCANE_DEMO_VALUE');
document.querySelector('#environment-value').textContent = value;

Reference group

Filesystem, storage, preferences, and appearance

Repository and reviewed source access