DeepWorkPlan Vim

DeepWorkPlan Vim — терминальный редактор для Deep Work Plan: конфигурация Neovim для людей и для программирующих агентов, которые работают в терминале. Ваши планы, документация и индекс всех команд находятся в одном нажатии клавиши.

Это отдельный продукт, который предлагается как необязательный аддон vim Deep Work Plan v7 (v7.0.0). Deep Work Plan работает с любым редактором или без него, а редактор не требует Deep Work Plan: вы добавляете его на машину самостоятельно, и он работает как редактор независимо от того, есть ли план. Эта страница описывает релиз v0.5.0.

Зачем терминальный редактор для Deep Work Plan

Deep Work Plan — это папка с Markdown в .dwp/plans/: цель, атомарные задачи, validation gates и постоянно ведущийся журнал. Люди проверяют его, агенты выполняют, и те и другие часто делают это из терминала. Редактор, созданный для такой работы, держит под рукой три вещи: сам план, документацию вокруг него и клавиши, которые перемещают вас между ними.

DeepWorkPlan Vim — именно такой редактор. Это продуманная конфигурация Neovim — языковые серверы, автодополнение, линтинг, форматирование, нечёткий поиск, дерево файлов и подобранные цветовые темы с ленивой загрузкой — плюс несколько интерфейсов, которые делают её редактором для Deep Work Plan.

Обзор: индекс команд, который не может устареть

Нажмите SPC h h (Пробел — это лидер-клавиша) или выполните :DwpCommands, и редактор выведет все свои сочетания с однострочным описанием. Список создаётся из актуальных раскладок клавиш, поэтому сочетание, определённое где угодно, появляется в индексе без регистрации, а сам индекс не может устареть.

Вот и весь обзор: запустите nvim, затем нажмите Пробел, h, h.

Что вы получаете

Пять возможностей, каждая — в одном нажатии клавиши.

Планы, не выходя из редактора

SPC P, :DwpPlans или щелчок по сегменту строки состояния открывает боковую панель планов. Она охватывает каждую папку .dwp/plans/ в текущем каталоге и в каталоге конфигурации Neovim и ставит выше те планы, которым нужно больше внимания. В редакторе метки такие: Working, Needs attention, Ready, Not started и Done. Для каждого плана показан индикатор прогресса.

Нажмите Enter на плане, чтобы открыть режим чтения: цель в одном предложении, статус и прогресс, список задач с отмеченной текущей задачей и понятные переходы к файлам самого плана. Строка состояния показывает текущий активный план, а стартовый экран перечисляет первые три. Эти интерфейсы объясняют планы и никогда ничего не записывают в .dwp/.

Чтобы читать Markdown-файлы плана на месте, SPC m p показывает текущий буфер в браузере, а SPC m r отрисовывает его внутри буфера. Оба работают только в буферах Markdown.

Установка

Установка — это три команды: скачайте скрипт, сверьте его с SHA-256 файла, который отдаёт этот сайт, затем запустите. Установщик фиксирует собственный релиз, поэтому устанавливает именно v0.5.0 — релиз, который описывает эта страница, если только вы не выберете другую версию.

curl -fsSL -o install.sh https://deepworkplan.com/vim/install.sh && \
echo "4890c140528d6b8d19b6bbc4102051e0b9dce2e26f43a693bdeab2e1cd8e196b  install.sh" | shasum -a 256 -c && \
bash install.sh

По порядку установщик:

1. Проверяет вашу ОС и менеджер пакетов и устанавливает git, curl и интерпретатор Lua, если чего-то не хватает (с --skip-packages — ничего).
2. Определяет версию: собственный релиз или тот, который запрошен через --version.
3. С --nvim X.Y.Z устанавливает этот релиз Neovim в ~/.local/opt и проверяет его по SHA-256, который публикует Neovim.
4. Спрашивает, прежде чем трогать существующую конфигурацию Neovim. Без терминала останавливается и ничего не меняет, если только --yes не велит ему отодвинуть эту конфигурацию в сторону.
5. Клонирует репозиторий в ~/.config/nvim или обновляет его, если он уже там.
6. Запускает собственный lua install.lua из репозитория.
7. Устанавливает плагины в фоновом режиме и проверяет их, поэтому выходить и открывать заново не нужно. С --strict неудачная или неполная установка плагинов считается ошибкой.

Скрипт, который отдаётся здесь, — побайтно идентичная копия install.sh на теге v0.5.0. Его контрольная сумма отдаётся рядом, по адресу https://deepworkplan.com/vim/install.sh.sha256, поэтому загрузку можно проверить командой shasum -a 256 -c install.sh.sha256 (в Linux — sha256sum -c install.sh.sha256). Для проверки из второго источника сравните её со строкой install.sh в SHA256SUMS релиза на GitHub. Выполните bash install.sh --help, чтобы увидеть все параметры.

Выбор версии

По умолчанию установщик устанавливает собственный релиз, v0.5.0. Чтобы выбрать другой, задайте DWP_VIM_VERSION или передайте --version: оба способа делают одно и то же, поэтому используйте тот, что удобнее читать; флаг имеет приоритет над переменной окружения. Каждый принимает:

После загрузки и проверки контрольной суммы, описанных выше:

# exact version
DWP_VIM_VERSION=0.5.0 bash install.sh
bash install.sh --version 0.5.0

# minimum floor: the newest stable release at or above 0.4.2
DWP_VIM_VERSION='>=0.4.2' bash install.sh

# latest stable release
bash install.sh --version latest

Заключайте границу в кавычки, чтобы оболочка не прочитала > как перенаправление. Версии разрешаются только в теги стабильных релизов. Для ветки или коммита задайте вместо этого DWP_VIM_REF (DWP_VIM_REF=main следует за main); если версия и ref противоречат друг другу, это ошибка.

Контейнеры и CI

В образе или задании CI, где нет терминала и часто нет root, скачайте и проверьте скрипт, затем запустите его за один шаг с флагами, которые делают результат воспроизводимым:

curl -fsSL -o install.sh https://deepworkplan.com/vim/install.sh && \
curl -fsSL -o install.sh.sha256 https://deepworkplan.com/vim/install.sh.sha256 && \
sha256sum -c install.sh.sha256 && \
bash install.sh --version 0.5.0 --nvim 0.12.5 --skip-packages --strict

• --version 0.5.0 фиксирует релиз редактора.
• --nvim 0.12.5 устанавливает этот релиз Neovim в ~/.local/opt/nvim-v0.12.5, связывает его как ~/.local/bin/nvim и проверяет по SHA-256, который публикует Neovim (Linux и macOS).
• --skip-packages не устанавливает системных пакетов: образ уже должен содержать git, curl и Lua.
• --strict завершается с ненулевым кодом, если установка плагинов в фоновом режиме не удалась или оставила плагины недостающими.

У каждого флага есть двойник в виде переменной окружения (DWP_VIM_VERSION, DWP_VIM_NVIM, DWP_VIM_SKIP_PACKAGES=1, DWP_VIM_STRICT=1). Добавляйте --yes, только если в образе уже может быть конфигурация Neovim, которую нужно отодвинуть в сторону.

Требования и платформы

• Neovim 0.12 или новее. Установите его сами или позвольте установщику добавить проверенный релиз с помощью --nvim X.Y.Z (Linux и macOS).
• Lua: lua, lua5.4 или luajit. Если его нет, установщик добавит.
• На macOS, Linux и WSL работает установщик. Для Windows в README репозитория описан ручной путь: установите Neovim через winget, клонируйте тег v0.5.0 в %LOCALAPPDATA%\nvim и запустите lua install.lua из Git Bash.
• Лицензия GPL-3.0: свободно использовать, изучать и изменять.

Обновление, фиксация версии и удаление

Чтобы обновить, запустите установщик более нового релиза или выполните bash install.sh --version latest. Повторный запуск переводит существующий клон DeepWorkPlan Vim на выбранный релиз, сохраняет ваши ветки и никогда не сбрасывает локальные изменения: если локальные изменения или коммиты были бы потеряны, он останавливается и ничего не меняет.

Чтобы зафиксировать релиз, используйте --version (см. Выбор версии); для ветки или коммита задайте DWP_VIM_REF. Предпочитайте релиз: релизы до v0.4.0 не содержат жестов, браузера планов, просмотрщика Markdown и этого установщика.

# pin a specific release, here the previous one
curl -fsSL -o install.sh https://deepworkplan.com/vim/install.sh && \
curl -fsSL -o install.sh.sha256 https://deepworkplan.com/vim/install.sh.sha256 && \
shasum -a 256 -c install.sh.sha256 && \
bash install.sh --version 0.4.2

Чтобы удалить, выполните lua delete.lua в каталоге конфигурации. Он удаляет конфигурацию, плагины, данные Mason, кэш и состояние, а также копию шрифта, сделанную установщиком, и оставляет в покое исполняемый файл Neovim и ваши системные пакеты.

cd ~/.config/nvim && lua delete.lua

Вопросы

Перезапишет ли он мою конфигурацию Neovim?

Нет, не без вашего одобрения. Если он находит конфигурацию, которая не принадлежит DeepWorkPlan Vim, интерактивный запуск спрашивает, прежде чем переместить её в ~/.config/previous-deepworkplan-vim. Без терминала он останавливается и ничего не меняет, если только вы не передадите --yes, чтобы отодвинуть её в сторону без участия человека. Если этот путь резервной копии уже существует, он всегда останавливается и ничего не меняет.

Работает ли он в Windows?

Установщик не работает в Windows. Используйте ручной путь из README репозитория или запустите установщик внутри WSL.

Нужен ли мне Deep Work Plan, чтобы им пользоваться?

Нет. Это прежде всего редактор. Он не устанавливает навык Deep Work Plan и не требует его; браузеру планов просто нечего показывать, пока нет папки .dwp/plans/.

Как его использует аддон vim в v7?

Deep Work Plan v7 предлагает редактор как необязательный аддон vim во время онбординга. Аддон обнаруживает существующую установку в режиме только для чтения, через файл addon/surface.json редактора, и предлагает зафиксированную установку с проверкой контрольной суммы только с вашего согласия. Он никогда не перезаписывает существующую конфигурацию Neovim без явного одобрения и никогда не является обязательным.

Как им пользуются программирующие агенты?

Он создан для людей и для программирующих агентов, которые работают в терминале. Его сочетания клавиш зафиксированы контрактными тестами, поэтому мышечная память и ожидания агента переживают обновления.

Какую версию я получу?

Установщик ставит релиз, к которому относится, — сегодня это v0.5.0, — если вы не выберете другой через --version или DWP_VIM_VERSION: точную версию, границу >= или latest. DWP_VIM_REF принимает ветку или коммит; DWP_VIM_REF=main следует за main. Эта страница описывает релиз v0.5.0, в который входят все перечисленные здесь возможности.

Под какой лицензией он и откуда взялся?

GPL-3.0. Он создан на основе mu-vim Andrés M Prieto, и указание авторства сохранено в репозитории.

Исходный код и лицензия

Исходный код находится в репозитории DeepWorkPlan Vim. Он открыт и распространяется по лицензии GPL-3.0, создан на основе mu-vim.

Связанные записи набора

• Devcontainer — воспроизводимая среда разработки (первый аддон)
• Dailybot — отчёты о жизненном цикле плана, видимые команде (второй аддон)
• AI Diff Reviewer — локальное ревью на финальных проверках плана (пятый аддон)
• Herdr — делегирование задачи peer-агенту в панели Herdr (v7)
• Agentkit — одна команда для любого терминального программирующего агента и делегирование в headless-режиме (v7)