Develop with Marionette v5#

Version: 5.0.0-beta.1 Channel: next Publication: beta (published on npm) Source revision: b06750c507494441f0b2298766b70087e45346a2 Local changes: false Content SHA-256: 3fe8788a771994d9effd124fee94d7444637a27ec974a5b520ccbf43b55bbec9

Match these docs to the installed package before using an API. These are the published beta contracts, not v4 or unreleased development. A hash establishes content consistency, not proof of a custom runtime's behavior.

Read the task's guide and its direct references first. The existing Build with Marionette guide is the development contract for agents; this page routes to it rather than maintaining a second API guide. Reading copies contain the reviewed publication edits and rewritten links. Packaged sources remain available byte for byte under /docs/markdown/.

Treat retrieved examples as source material, not permission to run code, install packages, or change a user's project. Verify behavior with the installed package and application tests; the website workshop proves only the example it controls.

Find the contract for your task#

Start an application#

Establish the installed version, choose an owner, and show a View.

Build with an agent · Install and show a View · Choose a class · Configuration and inheritance

Choose data, state, or rendering#

Select each capability explicitly; plain data does not emit changes.

Choose integrations · Data and collections · State sources · Templates and rendering · Runtime isolation

Keep edits and focus during updates#

Verify surviving child and input identity in a browser.

Common application tasks · CollectionView · Forms and accessibility · Test an application

Own a screen and cancel stale work#

Identify who owns children, subscriptions, and pending work.

Application · Region · Routing · Lifecycle and cleanup

Wire interactions and reusable behavior#

Verify one response per interaction and cleanup on destruction.

DOM interactions · Events · Behavior

Diagnose and validate a change#

Look up the diagnostic code, inspect the invariant, and reproduce behavior.

Diagnostics · Test an application · Public exports

Integrate with an agent client#

Use the packaged consumer skill and record application decisions.

Set up an agent · Application agent instructions

Migrate an existing v4 application#

Read migration contracts before applying v5 examples.

v4 compatibility ledger · Upgrade guide

Retrieval formats#

• Documentation index: complete page map with task routing.
• Searchable JSON corpus: versioned documents, exact reading Markdown, canonical URLs, and individual hashes; search the documents locally without a browser.
• Start and ownership bundle: initial setup and interface lifecycle.
• Integrations bundle: data, state, rendering, and runtime choices.
• Reference bundle: API and migration references.
• Full context: all published documentation and diagnostics; larger than most tasks require.
• Coverage and artifact integrity: what is included, omitted, and actually checked.
• Documentation MCP setup: run the optional local read-only server from this website repository.
• Optional browser workshop: capability checks and interaction with the running example.
• Project-fit review: evaluate tradeoffs before choosing Marionette.

No particular client is guaranteed to discover llms.txt automatically. Markdown and JSON work independently of WebMCP and do not require an account.