Installation

How to install workflows and configure your project.

Prerequisites

• Node.js 18 or later
• A TypeScript project (recommended)

init

Use the init command to create a workflowkit.json configuration file:

npx workflowkit init

You will be asked a few questions to configure your project:

? Where should workflows be installed? src/workflows
? Where should steps be installed? src/steps

workflowkit.json

The configuration is stored in workflowkit.json:

{
  "$schema": "https://workflowkit.io/schema.json",
  "aliases": {
    "workflows": "src/workflows",
    "steps": "src/steps",
    "hooks": "src/hooks"
  }
}

Add workflows

You can now start adding workflows to your project:

npx workflowkit add code-review

This will install the code-review workflow and all its dependencies (steps) to your project.

Install dependencies

After adding workflows, install the required npm packages:

npm install ai @ai-sdk/anthropic octokit

That's it

You can now import and use the workflows in your project.