Public API reference
The public surface of each skelm package is locked by baselines in scripts/guards/baselines/. Those files are the source of truth — this page indexes them.
A pnpm guards run regenerates each baseline and fails CI if a public export is added or removed without an explicit baseline update. That gate is what keeps the API page honest.
Packages
| Package | Baseline | Description |
|---|---|---|
@skelm/core | core.txt | Pipelines, builders, runner, types, contexts |
@skelm/cli | cli.txt | CLI entry points and argv plumbing |
@skelm/gateway | gateway.txt | Gateway runtime, audit/secrets/approvals enforcement |
@skelm/integrations | integrations.txt | First-party connectors |
@skelm/metrics | metrics.txt | Metrics adapters |
@skelm/opencode | opencode.txt | OpenCode adapter |
@skelm/otel | otel.txt | OpenTelemetry adapter |
@skelm/pi | pi.txt | Pi backend |
@skelm/scheduler | scheduler.txt | Scheduler primitives |
skelm | skelm.txt | Meta-package re-exports |
Adding a new export
- Add the export in
packages/<pkg>/src/index.ts. - Run
pnpm build && pnpm guards— the guard will fail with the diff. - Update the relevant baseline file with the new entries.
- Mention the addition in the package's changelog (see issue #35 for the changesets workflow).
Stability
- Anything in a baseline is part of the public API. Removing or renaming requires a major version bump and an entry in the changelog.
- Anything not in a baseline is internal and may move at any time.