How-To Guides
Task-oriented, step-by-step procedures. Each guide solves one specific problem and assumes you know the basics (tutorials teach them).
The nwdes how-tos below are written for your assistant to run — see
For your assistant for the sentence to
paste and who runs what.
Deliver and fix
| Guide | Description | Level |
|---|---|---|
| Deliver a feature | Walk one Request through the nwdes route: handoff, product facts, design, oracle, craft, review, examination, integration | Intermediate |
| Fix a bug | Route one observed defect through the lean nwdes route | Intermediate |
| Use feature lanes | Isolate one feature in its own worktree and integrate it without rewriting trunk | Intermediate |
| Run features in parallel | Throughput and swarm on one box: when to open lanes, capacity admission, integrate and close | Advanced |
| Deliver a slice with scenario-to-row mapping | One acceptance scenario per acceptance row, observed RED then GREEN, on the nwdes route | Intermediate |
| Resolve an outcomes collision | Triage an nwave-ai outcomes check flag against an existing outcome |
Intermediate |
| Invoke reviewer agents | Request peer reviews from reviewer agents | Intermediate |
Recipes
| Guide | Description | Level |
|---|---|---|
| nWave Cookbook | Copy-paste recipes for architecture, refactoring, docs, tests and feature delivery, grounded in this repository | Beginner |
Install and set up
| Guide | Description | Level |
|---|---|---|
| Installation guide | Full setup for Claude Code and the shared surface, with recovery | Beginner |
| Installing for Codex CLI | Codex install + verification checklist | Beginner |
| Installing for Cursor | Cursor hook wiring + verification checklist | Beginner |
| Installing for Devin CLI | Skills-only Devin integration | Beginner |
| Installing for OMP | OMP agents, skills, commands and extension | Beginner |
| Offline install | Install without network access to the package index | Intermediate |
| Team rollout | Roll nWave out to a team | Intermediate |
| Activate nWave in a project | Turn nWave on or off per repository and check status | Beginner |
| Assign models to roles | Run one role on a different model, per host | Beginner |
| Set review rounds and examine level | See and change how much checking a project gets; your assistant asks and sets it | Beginner |
| Configure documentation density | Set how much documentation nWave produces | Beginner |
| Configure Jev | Turn Jev on or off per project, and set the TYPESAFE_API_KEY variable |
Beginner |
| Read architecture diagrams and the readable brief | Turn on the readable output, check that a diagram is accessible, and see what the documentarist does | Beginner |
Upgrade and recover
| Guide | Description | Level |
|---|---|---|
| Migrate from nWave 3.x | Upgrade a 3.x installation to v4, with backup and restore | Intermediate |
| Update an existing project | nwave-ai update and the project compatibility boundary |
Intermediate |
| Migrate to the SSOT model | 3.x-era document-model migration, kept for existing 3.x projects | Intermediate |
| Plugin migration guide | Move from a custom installer to plugin installation | Intermediate |
| Troubleshooting guide | Quick fixes for common nWave issues | Intermediate |
Extend
| Guide | Description | Level |
|---|---|---|
| Develop and install tool plugins | Build and install standalone CLIs (e.g. nwave-dedup) that extend nWave | Intermediate |
| Plugin use cases | Four practical use cases with prompts and expected output | Beginner |
Per-host support depth (what is installed where, and what verifies it) is the vendor support matrix. Concepts behind these tasks are in Explanation.