The terminal editor for DeepWorkPlan: a Neovim configuration for people and coding agents reviewing files, changes and plans in a terminal.
When agents work across repositories and terminal panes, you need to inspect what changed and see which plans and lanes need attention. DeepWorkPlan Vim combines file navigation, Git diffs, a searchable command index and read-only plan views in one editor. It works on its own; DeepWorkPlan and Herdr are optional.
The current release is v0.7.0, for macOS, Linux or WSL, with Neovim 0.12+. Download the tag-pinned installer and release checksums, verify the installer, then run it from a terminal:
curl -fsSL -o install.sh https://github.com/DailybotHQ/deepworkplan-vim/releases/download/v0.7.0/install.sh
curl -fsSL -o SHA256SUMS https://github.com/DailybotHQ/deepworkplan-vim/releases/download/v0.7.0/SHA256SUMS
awk '$2 == "install.sh" { print }' SHA256SUMS | shasum -a 256 -c -
bash install.sh --version 0.7.0
nvimThe verification prints install.sh: OK. On Linux, sha256sum -c - can replace
shasum -a 256 -c -. Stop if verification fails. The
release assets
also include install.sh.sha256, surface.json and the source archive.
The website's installer mirror is usable
when its checksum matches the pinned release.
The installer preflights git, curl and Lua, clones the configuration to
~/.config/nvim, runs system setup and installs the pinned plugins headlessly.
It asks before moving an existing foreign configuration to
~/.config/previous-deepworkplan-vim; without a terminal it stops unless backup
is explicitly authorized with --yes. Local edits are preserved through that
backup path rather than overwritten. Rerunning updates an existing installation.
For an image or CI environment that already provides git, curl, Lua, a C compiler, Node.js and pnpm, run the verified installer as a non-root user:
bash install.sh --version 0.7.0 --nvim 0.12.5 --skip-packages --strictThis installs checksum-verified Neovim into ~/.local/opt, links it under
~/.local/bin and fails on incomplete or unpinned plugin installations. Put
~/.local/bin on PATH (/home/dev/.local/bin for the contributor image’s dev
user). bash install.sh --help lists version selection, offline
sources and all other options; development commands
cover the contributor container and mesh.
On Windows, install Neovim with winget install -e --id Neovim.Neovim, then use
Git Bash with git and Lua on PATH:
git clone --branch v0.7.0 https://github.com/DailybotHQ/deepworkplan-vim.git "$LOCALAPPDATA/nvim"
cd "$LOCALAPPDATA/nvim" && lua install.lua
nvimFor a manual Unix install, clone the same tag into ~/.config/nvim and run
lua install.lua there. To uninstall, run lua ~/.config/nvim/delete.lua
(Windows: lua "$LOCALAPPDATA/nvim/delete.lua" in Git Bash). It lists the paths
and asks before removal; Neovim itself stays installed.
SPC means the leader key, Space by default. Start with SPC h h:
its searchable command index is generated from the live mappings.
| Action | Keys or command | What you see |
|---|---|---|
| Find files | SPC f f / SPC n |
A file finder or the file tree. |
| Review changes | SPC g d |
A side-by-side Git diff; repeat to close it. |
| Browse plans | SPC P / :DwpPlans |
Plans grouped by status with progress; Enter opens the plan reader and Tab expands tasks and files. |
| Inspect the orchestra | SPC O / :DwpLanes, or L on a plan in the browser |
Recorded lanes and child plans with optional live peer state. |
| Preview Markdown | SPC m p / SPC m r |
A browser preview or rendered Markdown in the buffer. |
| Discover commands | SPC h h / :DwpCommands |
Every live mapping, grouped and searchable. |
The plan browser reads .dwp/plans in the current repository and the editor's
configuration directory. The reader explains the goal, task checklist and plan
files; the statusline and start screen also expose plan progress. These surfaces
never write your plans. Clipboard shortcuts include Ctrl-a to select all and
SPC y to copy in normal or visual mode.
The lanes view reads ORCHESTRATOR_MANIFEST.md and README lane/child-plan tables,
with manifest fields taking precedence. It shows repository, peer address,
account, branch, child plan, recorded status and dependencies when present.
For example, a recorded lane with no helper installed appears as:
Orchestra — Example plan
Live status unavailable: herdr-peers is not installed.
vim · unavailable
Repository: deepworkplan-vim
Peer: local:w1:p2
Branch: feat/example
r refresh · q / Esc close · read-only
With herdr-peers on PATH, the editor asynchronously runs the read-only
herdr-peers lanes --json command and accepts herdr-peers/lanes-v1, protocol 1.
Matching peer addresses gain a timestamped snapshot: working, idle,
blocked, done, unknown, no_agent or unreachable, plus agent/profile,
attention screen and open ask count. r refreshes disk and live status;
q / Esc closes the view. Missing helpers, timeouts and unsupported JSON keep
recorded lanes visible with explicit unavailable status. This is a snapshot,
not continuous monitoring. View contract and keys.
The optional vim addon installs or detects this editor using its tag-pinned, machine-readable addon surface. The DeepWorkPlan pack manages repository onboarding and durable plans; the editor lets a person or agent read those plans and review the resulting changes.
herdr-peers supplies optional lane snapshots; coding-agents-kit manages the coding agents and their profiles; devcontainer-kit provides a container environment for the tools. The lanes view displays recorded accounts and optional runtime profiles; it does not launch agents, pick accounts, send messages or change child repositories. Adoption starts at the quickstart.
DeepWorkPlan turns any repository into an AI-first, agent-pilotable codebase. These projects ship together; every addon is optional.
| Repository | Role | Purpose |
|---|---|---|
| deepworkplan-skill | Pack | The methodology, specification and kit as an installable agent skill |
| coding-agents-kit | Addon: agentkit | One command for every coding agent: accounts, quota, ak pick, headless runs |
| devcontainer-kit | Addon: devcontainer | A reproducible dev container per repository, wired to Herdr and the host's accounts |
| herdr-peers | Addon: Herdr | Ask an agent in another Herdr pane, on any machine, and get one authorized reply |
| deepworkplan-vim (this repository) | Addon: DeepWorkPlan Vim | The terminal editor for plans: plan browser, lanes view, Markdown viewer |
| ai-diff-reviewer | Required local review | Reviews a change set locally and in CI; every Final Review runs it |
| agent-skill | Addon: Dailybot | The Dailybot agent skill: progress reports, check-ins, chat and more |
| deepworkplan.com (source) | Site and hub | The methodology, specification, kit catalog and /init.md; coordinates the ecosystem |
Verify release assets before execution. The installer can install system prerequisites and run plugin setup; read it before granting those actions. Plugins and pckr are pinned by commit in the lockfile; Mason language servers and Treesitter parsers are fetched at runtime and are not covered by that lock. Keep credentials outside committed configuration and plans. Plan and lane views are read-only, and live lookup uses a fixed command with a three-second timeout. The contributor container publishes SSH on loopback and mounts host SSH files read-only. Report vulnerabilities privately through SECURITY.md; the security guide covers the details.
| Topic | Guide |
|---|---|
| Product scope and editor capabilities | Product specification |
| Boot chain, modules and releases | Architecture |
| Installation, container, mesh and validation commands | Development commands |
| Plans and orchestra view | Plans sidebar |
| Plugins and language tools | Plugin guide |
| Sidebar settings and user overrides | Configuration |
| Key reference | Cheat sheet |
| Addon integration contract | Addon guide |
| Contributor container | Container guide, local image |
| Tests and required gates | Testing guide |
| Agent instructions | AGENTS.md |
Read CONTRIBUTING.md for setup, gates and the pull-request process, and CODE_OF_CONDUCT.md for community expectations. CHANGELOG.md records each release. Merges publish a new release only when the tree declares a new version; this README update keeps v0.7.0.
GPL-3.0. Derived from AndresMpa/mu-vim by Andrés M Prieto; CREDITS.md preserves the lineage. Keep the license and credit in copies and derivatives.