Operations
Version Compatibility
Supported Node, package, and runtime compatibility.
Use this page to keep package, config, envelope, provider, and docs compatibility claims precise.
Baseline
| Area | Current public baseline |
|---|---|
| Node.js | 20.11 or newer for package builds, scripts, and CLI usage |
| Package manager | npm workspace workflow |
| Main app facade | @meshkit/meshkit |
| Core package | @meshkit/core |
| CLI package | @meshkit/cli |
| MCP package | @meshkit/mcp |
| Runtime packages | Web, Node, React Native, Ionic pages in this docs tree |
| Config version | version: 1 |
Compatibility Boundaries
| Boundary | Why it matters |
|---|---|
| Package version | APIs and generated references can change |
| Config version | Provider config parsing depends on schema |
| Envelope version | Old clients must know how to open stored content |
| Provider metadata | Proofs, capsules, mailboxes, and sync records must remain readable |
| Runtime package | Key storage and stream behavior depend on platform support |
| CLI version | Validation output and command flags can change |
Documentation Rule
When a release changes a user-facing behavior, update:
- the task guide
- the concept page
- the reference page
- troubleshooting
- migration or compatibility notes
Do not leave important compatibility facts only in release notes or internal ADRs.
Status Language
| Use | Avoid |
|---|---|
| "Supported in the current TypeScript packages" | "Works everywhere" |
| "Requires provider metadata support" | "Works with IPFS" |
| "Roadmap" | "Available soon" |
| "Validated by this command" | "Production-ready" without evidence |
| "Bridge-backed Filecoin persistence" | "Direct Filecoin client" |