# Docs


- **Get started**
- [Introduction](/docs): Durable workflows for TypeScript, backed by PostgreSQL.
- [Quickstart](/docs/quickstart): Run your first durable workflow against Postgres in about two minutes.
- [Install with an agent](/docs/install-with-agent): Hand the setup to Claude Code, Cursor, Codex, or any coding agent that can fetch a URL.
- [Architectures](/docs/architectures): Run pg-workflows in a single service, or as microservices with web and worker services.

- **Guides**
- [Examples](/docs/guides/examples): Conditional steps, loops, reminders, polling, retries, and progress.
- [AI and agent workflows](/docs/guides/ai-agents): Durable LLM pipelines, human review, and retrieval.

- **Concepts**
- [Workflows and steps](/docs/concepts/workflows): Define a workflow, configure it, and make each unit of work durable with step.run.
- [Events](/docs/concepts/events): Pause a run until your code delivers an event with triggerEvent.
- [Timers](/docs/concepts/timers): Delay a run for a duration or until a date.
- [Polling](/docs/concepts/polling): Check a condition on an interval until it holds or times out.
- [Pause and resume](/docs/concepts/pause-and-resume): Pause runs manually, resume them, or complete a waiting step with fast-forward.
- [Child workflows](/docs/concepts/child-workflows): Start a workflow from another workflow and wait for its output.
- [Retries and timeouts](/docs/concepts/retries-and-timeouts): How failed runs are retried, and what timeouts do.
- [Recurring schedules](/docs/concepts/recurring-schedules): Start runs on a cron expression or a fixed interval.
- [Priorities](/docs/concepts/priorities): Order runs in the queue with named or numeric priorities.
- [Singleton workflows](/docs/concepts/singleton-workflows): Allow at most one pending or running run of a workflow.
- [Resource IDs and idempotency](/docs/concepts/resource-id-and-idempotency): Scope runs to a tenant, and deduplicate starts.
- [Input validation](/docs/concepts/input-validation): Validate and type workflow input with any Standard Schema library.

- **UI Components**
- [Dashboard setup](/docs/ui): Browse and control runs with the @pg-workflows/ui React dashboard.
- [Components](/docs/ui/components): The dashboard components, and how to compose them.
- [Custom UI with hooks](/docs/ui/hooks): Build your own run views on the @pg-workflows/ui hooks.
- [API reference](/docs/ui/reference): Entry points, CLI, components, hooks, server adapters, HTTP API, and styling.

- **Observability**
- [Tracing](/docs/observability/tracing): OpenTelemetry spans for every workflow execution and step with @pg-workflows/otel.
- [Monitoring runs](/docs/observability/monitoring): Query run state from code, or browse it in the dashboard.

- **Reference**
- [API reference](/docs/reference/api): WorkflowEngine, WorkflowClient, workflow(), refs, context, types, and errors.
- [Configuration](/docs/reference/configuration): Environment variables, database objects, retries, and requirements.