Ensemble documentation
Guides to how Ensemble works today, with the code paths that implement it. Start with the overview (what works and its limits), then the guide for your area. Setup is in the root README; AGENTS says which doc to update with which code.
The public site is built from these same sources for docs.ensemblework.com. 40 · Public documentation describes its build, hosting and Context Bridge lookup.
Product and architecture
| Guide | Contents |
|---|---|
| 00 · Overview | Surfaces, what works and what does not, deployment forms, domain model |
| 01 · Stack and environment | Stack, configuration, local setup, models, tests, CI and deploys |
| 02 · Hub | Navigation, Today, Board, pages, Context, settings, accounts, API map |
| 03 · Context | Connectors, explicit acquisition, people and identities, meetings, retrieval |
| 04 · Personal skills | Versioned instructions, routing, morning brief, completed-work learning |
| 05 · Orchestration | Scheduler, durable jobs, queue slots, decisions, stop and retry |
| 06 · Workspace | Assignment, execution, publishing, run evidence |
| 07 · Governance | Access, approvals, audit, retention, erasure, metrics, interaction log, AI activity log and dashboards |
| 11 · Assistant | How a turn works, context, playbooks, Apply and Undo, extending it |
| 34 · Assistant actions | Exact action and tool map, tiles and layouts, limits |
| 39 · Ensemble tools | What the assistant, a node and a node's agent run can do in each area of Ensemble, what is not offered and why, never Ensemble in a browser |
| 17 · Repository map | Apps, packages, folders and ownership |
Features
| Guide | Contents |
|---|---|
| 16 · Code | Review and edit, source control, the human terminal |
| 20 · Plots | Datasets, charts, browser and server rendering, export |
| 21 · Diagram language · cheat sheet · 22 · for agents | Block diagram DSL, layout, JSON, editor |
| 27 · Imports | Imports from other apps: preview, mapping, jobs, undo |
| 28 · Spaces | Separate workspaces, scope, settings, export |
| 29 · Sharing | Roles, public links, presence, live co-editing |
| 30 · Engines and subscriptions | External agent engines, handoffs, assistant subscriptions |
| 31 · Connected apps | Connector catalog, connection methods, item actions, MCP |
| 32 · Files | Originals and blob storage, previews, edits, extraction, caps |
| 33 · Included AI | Operator-provided models, monthly credits, reservations |
| 35 · Ensemble Node | AI teammates in DMs, crews and rooms with other people: requests to join, search, pins, shared sign-in, credits, tools and computer jobs |
Clients and shared systems
| Guide | Contents |
|---|---|
| Desktop | Desktop app architecture, build, packaging, updater, OS support |
| Mac checklist | Hand checks for macOS installers |
| 24 · Sandboxing | OS sandbox backends, trust, outside access, git |
| 25 · Remote tasks | Pairing, leases, files, Code and terminal on a paired computer |
| 26 · CLI | Install, terminal UI, commands, runner, MCP, releases |
| Quick capture | Tray app with a global shortcut |
| Context Bridge | MCP server for editors: reads, and changes with a key that allows them |
| 40 · Public documentation | Static docs site, stable URLs, public search and authenticated ensemble_docs lookup |
| Brand | Shared artwork, palettes, motion, generated assets |
| Caching and UI performance | Caches, relay state, performance budgets |
| 36 · Web and CLI testing | Isolated live Hub and testing CLI, fast checks, agent workflow and production promotion |
| 37 · Fast pipeline and paused checks | What runs on testing, main and release tags; the slower suites paused in full-checks.yml and how to bring them back |
| 38 · Agents and attached files | How every attached file, picture, plot and diagram reaches models and agents in chat, Ensemble Node and tasks; retries after a provider's refusal; each subscription agent's input form; extracted text off |
| Demo data | Explicit sample-data commands and fixtures |
Operator-specific hosting, accounts and credentials are in the git-ignored private/ folder.