Reference
Reference pages define exact public contracts. Start with the quickstart for a complete workflow or What is marimo-export? for the main concepts.
Author and inspect exports
| Need | Reference |
|---|---|
| Declare a state space and output sources | StateSpace and ExportSpec |
| Match a notebook value to a stored form and consumer | Output representations |
| Implement or inspect the portable directory | Export format |
| Run commands or consume human and machine output | CLI |
Use Python
| Need | Reference |
|---|---|
| Choose the Python surface | Python API |
| Plan, prepare, capture, build, and write | Produce an export |
| Open, select, decode, and verify | Python reader |
| Parse value selectors or render a value in an accepted media type | Select and represent values |
| Connect to sessions and inspect notebooks | Sessions and inspection |
| Retain prepared work and observations | Repository and observations |
| Retain a Python prepared publication or commit an application directory | Delivery and publications |
| Integrate an interactive marimo host | Host integration |
| Encode canonical values or handle typed failures | Format records and errors |
Use a browser
| Need | Reference |
|---|---|
| Choose the browser surface | Browser API |
| Open, select, load, and verify | Browser reader |
| Follow a prepared manifest and commit browser state | Prepared publications |
| Decode or mount one representation | Output loaders |
| Consume rendered-output and complete-cell records | marimo snapshots |
| Handle failures and configure byte limits | Browser errors and limits |
Cross-language contracts
- Portable JSON defines the shared Python and JavaScript value boundary and identifies the published interfaces in each language.
- Compatibility defines Python, marimo, browser, package, and protocol boundaries.
- Terminology provides a short lookup map for project nouns.