API reference
This reference is generated from the eight public SharedOS package entry points. It documents the same symbols that consumers can import from each package root; private workspace packages, examples, tests, and implementation-only modules are not included.
Choose a package
| Package | Use it for |
|---|---|
@aicoo/sharedos-contracts | JSON-safe protocol types and runtime-validation schemas |
@aicoo/sharedos-core | Deny-by-default authorization, registries, dispatch, and audit |
@aicoo/sharedos-os | Standard permission-controlled files tools and adapters |
@aicoo/sharedos-runtime | One-turn execution, runtime plugins, and the standard runtime |
@aicoo/sharedos-http | Fetch-compatible HTTP service adapter |
@aicoo/sharedos-client | Runtime-validated HTTP client |
@aicoo/sharedos | Convenience re-export of the production packages |
@aicoo/sharedos-testkit | Deterministic in-memory fixtures for tests and examples |
The SDK adds no independent symbols, so re-exported definitions appear once on their owning package pages rather than being duplicated on the SDK page.
SharedOS separates compile-time TypeScript types from runtime validation. Parse untrusted values with the exported schemas at process and network boundaries; do not treat a type assertion as validation or authority.
Authoring model
Package READMEs explain when and why to use an API. TSDoc comments beside public
declarations explain individual symbols, parameters, return values, errors, and
security constraints. TypeDoc then follows each src/index.ts barrel and turns
those sources into this reference. Edit the README or source comment—not files
under docs/api, which are generated.
Generate the reference
pnpm docs:api
The command reads each package's src/index.ts, so the reference follows the
actual public export surface. Generated files live in docs/api. To verify that
the committed reference is current without modifying it, run:
pnpm docs:api:check
Package READMEs provide task-oriented introductions and examples. The pages below provide the complete generated signatures and member-level reference.