Reference
Complete command, API, SDK, policy, schema, and implementation-limit reference for isplay.
Use the reference section when you need exact surfaces rather than workflow guidance.
Packages
Workspace packages, package names, exports, dependencies, and intended users.
CLI
All commands, options, environment variables, JSON input rules, and gotchas.
API
Routes, resource relationships, request/response behavior, errors, and OpenAPI.
API client
Programmatic HTTP client, resources, options, error behavior, and method groups.
OpenAPI
Where to fetch the generated OpenAPI document and how it is produced.
SDK
SDK initialization, run context, capture methods, surface methods, and adapter interaction.
Policies
Replay, fixture, side-effect, capture, redaction, validity, and capability policies.
Events
Known event types, custom event rules, fields, and event-family guidance.
Interventions
Intervention kinds, patch shapes, target selectors, and stale-target guards.
Fixtures
Fixture requirements, tool fixtures, matchers, provenance, and replay resume behavior.
Metrics, diffs, effects
Comparison outputs, metric names, effect statuses, effect types, and validity labels.
Adapter capabilities
Capability manifest statuses and interception modes.
Schemas
Core object schemas, event types, intervention kinds, context inventory, and experiments.
Storage
Postgres tables, projections, artifacts, migrations, and backup implications.
Environment
All environment variables and defaults.
Errors
Structured API error shape, HTTP status meanings, and client error behavior.
Limits
Current implementation caveats, stubs, and behavior that should be documented honestly.
Package Names
| Package | Purpose |
|---|---|
isplay | Root package and CLI bin. |
@isplay/server | Hono API server and OpenAPI registration. |
@isplay/web | Private Next/Fumadocs documentation site workspace. |
@isplay/worker | Graphile Worker task registration for replay and experiment jobs. |
@isplay/core | Zod schemas, IDs, JSON serialization, capture policy, redaction. |
@isplay/api-client | OpenAPI fetch client and stable API errors. |
@isplay/sdk | Capture client, run context, API surface. |
@isplay/replay | Interventions, fixture gateway, replay engine, diff metrics. |
@isplay/analysis | Validity labels, effect ranking, analysis run construction. |
@isplay/postgres | Store, migrations, artifacts, context inventory, experiments. |
@isplay/adapter-kit | Shared adapter primitives. |
@isplay/adapter-ai-sdk | AI SDK model middleware and tool instrumentation. |
@isplay/adapter-mastra | Mastra helper adapter. |
@isplay/adapter-langgraph | LangGraph nodes, models, streams, and tools. |
@isplay/adapter-runtime | Shared runtime capability, fixture, JSON, and run-registry helpers. |
@isplay/adapter-codex | Codex hook and JSONL ingestion adapter. |
@isplay/adapter-claude-code | Claude Code hook and stream-json adapter. |
@isplay/adapter-openclaw | OpenClaw native plugin adapter. |
Published packages are ESM and export their root entrypoint.