Install with an agent
Hand the setup to Claude Code, Cursor, Codex, or any coding agent that can fetch a URL.
pg-workflows publishes an install skill: instructions written for coding agents. The agent reads your codebase, picks an architecture, installs and verifies the engine, mounts the dashboard for your stack, and offers to add tracing. It asks before touching your database.
Copy the prompt
Paste this into your agent, from the root of your project:
Add pg-workflows to this project. Fetch https://pgworkflows.dev/skill.md and follow it step by step: pick the right layout for this codebase (monolith, web app plus worker, or microservices), install and verify the engine, add the @pg-workflows/ui dashboard for our stack, then ask me whether to add OpenTelemetry tracing.
The agent fetches /skill.md and follows it. Nothing is installed in the agent itself.
Install the skill
To keep the skill available in every session, install it into your agent instead:
npx skills add SokratisVidros/pg-workflows --skill pg-workflows-installThen ask the agent to "add pg-workflows to this project". The skill's source is in skills/pg-workflows-install.
What the agent does
-
Inspects the project: package manager, services and their frameworks, hosting, the Postgres connection, React and Tailwind, and any existing OpenTelemetry setup.
-
Picks an architecture and tells you why:
Architecture When Monolith One long-running service starts and executes workflows. Web app plus worker One codebase whose web tier is serverless or shouldn't carry heavy workflow dependencies. A worker process joins it. Microservices Several services start runs with WorkflowClient. One worker service owns every workflow. -
Installs the engine and runs a workflow end to end against your database, showing you the output.
-
Adds the dashboard with the adapter for your stack: Next.js (App Router or Pages Router), Express, Fastify, Hono, TanStack Start, Bun, or Deno. The dashboard's API goes behind your existing auth.
-
Offers tracing with
@pg-workflows/otel, reusing your OpenTelemetry SDK if you have one. -
Reports every file it changed and what each process needs in production.
The same steps are documented for people in Architectures, UI components, and Tracing.
For agents
/skill.md: the install skill/llms.txt: an index of these docs/llms-full.txt: every page in one file- Every page has a Copy Markdown button, and its Markdown at
/llms.mdx/docs/<page>/content.md