Skip to main content

​
Prerequisites

  • Node.js >= 22

​
Install and Initialize

1

Initialize your project

npx dev-workflows init
This creates a .dwf/ directory with config.yml and empty rule files for each scope: architecture, conventions, security, testing, and workflow.The CLI detects existing AI tools in your project (CLAUDE.md, .cursor/, GEMINI.md, .windsurf/, .github/copilot-instructions.md) and pre-selects them.With a preset — bootstrap a full spec-driven workflow in one command:
npx dev-workflows init --preset spec-driven -y
2

Add rules from the registry (optional)

npx dev-workflows add typescript/strict
Installs rules from the GitHub registry into your .dwf/rules/ directory. Run devw add --list to see all available rules, or devw add for interactive selection.You can also install slash commands, templates, and hooks:
devw add command/spec         # slash command
devw add template/feature-spec # spec template
devw add hook/auto-format      # editor hook
3

Compile

npx dev-workflows compile
Generates editor-specific config files and deploys assets:
ToolOutput
Claude CodeCLAUDE.md
Cursor.cursor/rules/devworkflows.mdc
Gemini CLIGEMINI.md
Windsurf.windsurf/rules/devworkflows.md
VS Code Copilot.github/copilot-instructions.md
Assets are also deployed:
Asset TypeOutput
Commands.claude/commands/*.md
Templatesdocs/specs/*.md
Hooks.claude/settings.local.json

​
What’s Next

  • Write your own rules in .dwf/rules/ → Rules format
  • Learn about assets (commands, templates, hooks) → Assets
  • Validate your setup → devw doctor
  • Browse all commands → Commands