Stow documentation

Choose a guide for your application. The full reference covers the product. CONTEXT defines development terms.

Getting started

• Getting started: build a checkout and choose an API.
• Running a native server: startup, credentials and probes.
• TypeScript client and Python client.

Native storage and workspaces

• Portable workspace usage: preparation, checkpoints, guarded saves, handoff and adoption.
• Workspace contract, task manifests and shared conformance vocabulary.
• Run-through cache and durable outbox: offline reads, conditional propagation, retry and recovery.
• S3 compatibility contract: supported behavior and refusals.
• Native object MCP and optional MCP bucket browser.

Browser storage

• File history: local stages, undo/redo and explicit sync.
• Project storage: atomic revisions and shared content.
• Worker runtime: binary transport, streams and recovery.
• IndexedDB persistence: the original bounded object profile.
• Runnable editor.

Decisions and development

• Architecture decisions explain settled choices. Acceptance of a design does not mean every proposed API is implemented.
• Consolidated storage plan owns remaining work.
• Planning index separates the current queue, design references and historical records.
• Storage admission design describes the shared foundation contract; consult usage guides for implemented API names.
• Contributing and code standards.
• Release verification is a dated checkpoint, not evidence that a later candidate was published.

Evidence and history

History contains retired plans and experiments. For dated test results, see the assessment records, Railway browser tests and benchmarks.