AI SummaryThis Skill provides practical guidance for using the Upstash Workflow SDK to build serverless workflows with TypeScript. Developers building event-driven applications on Upstash will find it invaluable for quickly setting up and managing workflow endpoints.
Install
Copy this and paste it into Claude Code, Cursor, or any AI assistant:
I want to install the "upstash/workflow TypeScript SDK Skill" skill in my project. Please run this command in my terminal: # Install skill into the correct directory (16 files) mkdir -p .claude/skills/skills && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/SKILL.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/SKILL.md" && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/agents.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/agents.md" && mkdir -p .claude/skills/skills/basics && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/basics/client.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/basics/client.md" && mkdir -p .claude/skills/skills/basics && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/basics/context.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/basics/context.md" && mkdir -p .claude/skills/skills/basics && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/basics/serve.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/basics/serve.md" && mkdir -p .claude/skills/skills/features && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/features/flow-control.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/features/flow-control.md" && mkdir -p .claude/skills/skills/features && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/features/invoke.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/features/invoke.md" && mkdir -p .claude/skills/skills/features && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/features/retries-failures-reliability.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/features/retries-failures-reliability.md" && mkdir -p .claude/skills/skills/features && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/features/wait-for-event.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/features/wait-for-event.md" && mkdir -p .claude/skills/skills/features && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/features/webhooks.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/features/webhooks.md" && mkdir -p .claude/skills/skills/how-to && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/how-to/local-dev.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/how-to/local-dev.md" && mkdir -p .claude/skills/skills/how-to && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/how-to/middleware.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/how-to/middleware.md" && mkdir -p .claude/skills/skills/how-to && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/how-to/migrations.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/how-to/migrations.md" && mkdir -p .claude/skills/skills/how-to && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/how-to/realtime.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/how-to/realtime.md" && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/rest-api.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/rest-api.md" && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/skills/troubleshooting.md "https://raw.githubusercontent.com/upstash/workflow-js/main/skills/troubleshooting.md" Then restart Claude Code (or reload the window in Cursor) so the skill is picked up.
Description
Lightweight guidance for using the Upstash Workflow SDK to define, trigger, and manage workflows. Use this Skill whenever a user wants to create workflow endpoints, run steps, or interact with the Upstash Workflow client.
Quick Start
The Upstash Workflow SDK lets you expose serverless workflow endpoints and run them reliably using QStash under the hood. Install: `bash npm install @upstash/workflow ` Define a simple workflow endpoint: `ts import { serve } from "@upstash/workflow"; export const { POST } = serve(async (context) => { await context.run("step-1", () => console.log("step 1")); await context.run("step-2", () => console.log("step 2")); }); ` Trigger it from your backend: `ts import { Client } from "@upstash/workflow"; const client = new Client({ token: process.env.QSTASH_TOKEN! }); await client.trigger({ url: "https://your-app.com/api/workflow" }); `
Other Skill Files
These files contain the full documentation. Use them for details, patterns, and advanced behavior. • basics: • basics/serve – How to expose workflow endpoints. • basics/context – Full API for workflow context (steps, waits, webhooks, events, invoke, etc.). • basics/client – Using the Workflow client to trigger, cancel, inspect, and notify runs. • features: • features/invoke – Cross‑workflow invocation. • features/reliability – Retries, failure callbacks, and DLQ. • features/flow-control – Rate limits, concurrency, and parallelism. • features/wait-for-event – Notify and wait-for-event patterns. • features/webhooks – Webhook creation and consumption. • how to: • how-to/local-dev – Local QStash dev server and tunneling. • how-to/realtime – Realtime and human‑in‑the‑loop workflows. • how-to/migrations – Migrating workflows safely. • how-to/middleware – Adding middleware to workflows. • other files: • rest-api – Low-level REST endpoints for interacting with QStash/Workflow. • troubleshooting – Common debugging and environment issues. • agents – Using Workflow with agents, orchestrators, and automation patterns.
Discussion
Health Signals
My Fox Den
Community Rating
Sign in to rate this booster