Pulse documentation#
Pulse documentation is organized in layers so you can stop when you have enough detail. The 1.0.0-beta.1 candidate uses async-shaped managed handlers, trusted Pulse effects, a conventional .pulse/config.ts workspace, and the pulse CLI. The synchronized 18-package release catalog remains the authority for npm availability and support tiers.
1. Start and ship a first project#
- Getting started — install and create a first project.
- Project lifecycle — the normal
init → doctor → test → dev → buildjourney and the advancedinspect/compilebranches. - Beta scope — what the release guarantees and deliberately excludes.
- Canonical examples — nine source-bound projects,
including focused Entities, events, and MCP proxy shapes.
2. Follow a task-oriented guide#
- Migrate an Express service
- Fetching and composing data
- Explicit JSON schemas
- Static events and outbound emission
- Fastly config, secrets, and KV
- GRIP and Fanout
- Compatibility imports and migration
- Static Router authoring
- Node build and execution
- Fastly deployment candidates
- Troubleshooting
3. Understand the model#
- Compilation and lowering
- Effects and continuations
- Structured and opaque bodies
- Contracts and providers
- Targets and host work
- Package-owned lowering
- Entity engine, adapters, and facades
- Architecture overview
- Current architecture contracts
- Architecture vision
4. Use a package directly#
@pulse-compute/pulse@pulse-compute/runtime@pulse-compute/cli@pulse-compute/provider-fastly@pulse-compute/grip@pulse-compute/assets@pulse-compute/crypto@pulse-compute/jwt@pulse-compute/entities- All package support tiers
- Implementation packages
5. Look up exact behavior#
- Reference overview
- Canonical API
- Provider and target compatibility
- Managed handler TypeScript and JavaScript
- CLI
- Project configuration
- Diagnostics and remediation
- Environment variables
- Shell completion
- CLI machine specification
- Project configuration JSON Schema bundle