Skip to content

Reference ​

Look-up documentation for the exact surface: tools, commands, keyboard bindings, configuration, environment, storage, CLI, and supported hosts. Use a guide when you want to finish a task and this section when you need the precise answer.

The generated pages are rendered from the code's registries by npm run docs:reference and checked by npm run docs:check. Do not edit a generated page by hand; change the owning catalog or the reference metadata and regenerate.

Generated reference ​

SurfacePage
Six native tools: caller, gate, inputs, returns, examples, safetyNative tools
Eleven migration/legacy tools, separated from the native pathMigration and legacy tools
All : commands and the separate / composer catalogCommand reference
Keyboard bindings by contextKeyboard reference
Workspace .ensemble/config.json and stored settingsConfiguration
Environment variables and state pathsEnvironment
.ensemble, AGENTS.md, plugin storage, logs, and edit safetyFiles and storage
Doctor, data, backup, support bundle, logs, and exit codesOperator CLI
Supported hosts, Node, and contract constantsSupported hosts and versions

Other reference sources ​

SurfaceAuthoritative page
Platform boundary, live-suite prerequisites, and known limitationsSupport matrix
Runtime requirements and install commandsRequirements and Install
Backup, restore, and rollback proceduresBackup and restore and Rollback
Workspace configuration, storage, and retention policyData classes and retention
Release history and current npm tagsChangelog
Domain termsGlossary

Historical compatibility ​

Historical host reports stay public as evidence but are not current support claims:

Next ​

  • Concepts: why the surface is shaped this way.
  • Operations: procedures that use these commands.
  • Contributing: where generated reference and its contract tests live.

Released under the MIT License.