DeepWorkPlan Vim
DeepWorkPlan Vim — термінальний редактор для Deep Work Plan: конфігурація Neovim для людей і для програмувальних агентів, які працюють у терміналі. Ваші плани, документація та індекс усіх команд — на відстані одного натискання клавіші.
Це окремий продукт, який пропонується як необовʼязковий аддон vim Deep Work Plan v7 (pack v7.9.0). Deep Work Plan працює з будь-яким редактором або без нього, а редактор не вимагає Deep Work Plan: ви додаєте його на машину окремо, і він працює як редактор незалежно від того, чи є план. Ця сторінка описує реліз v1.0.1 — підтримувальний випуск першого стабільного релізу v1.0.0: починаючи з v1.0.0, інсталятор і його прапорці (з відповідними змінними DWP_VIM_*), поверхня аддона (addon/surface.json, інтерфейс 1), команди редактора :DwpPlans, :DwpLanes, :DwpCommands і :DwpConfig, ключі dwpvim.json і сполучення клавіш, закріплені контрактом відображень, змінюються несумісно лише в новій мажорній версії.
Навіщо термінальний редактор для Deep Work Plan
Deep Work Plan — це тека з Markdown у .dwp/plans/: мета, атомарні завдання, validation gates та журнал, що постійно ведеться. Люди переглядають його, агенти виконують, і ті й інші часто роблять це з терміналу. Редактор, створений для такої роботи, тримає поруч три речі: сам план, документацію навколо нього та клавіші, що переміщують вас між ними.
DeepWorkPlan Vim — саме такий редактор. Мета — міні-VS Code у терміналі: переходити між файлами, бачити, які файли змінено, переглядати diff і схвалювати чи відхиляти зміни; редактор дружній і легкий, орієнтований насамперед на агентів, зі станом плану, що завжди перед очима. Це дбайливо підготовлена конфігурація Neovim — мовні сервери, автодоповнення, форматування, нечіткий пошук, дерево файлів і дібрані кольорові теми з відкладеним завантаженням — плюс кілька інтерфейсів, що роблять її редактором для Deep Work Plan.
- План
- Завдання
- Gates
- Готово
Огляд: індекс команд, який не може застаріти
Натисніть SPC h h (Пробіл — це лідер-клавіша) або виконайте :DwpCommands, і редактор виведе кожну свою привʼязку з однорядковим описом. Список створюється з актуальних розкладок клавіш, тож привʼязка, визначена будь-де, зʼявляється в індексі без реєстрації, а сам індекс не може застаріти.
Ось і весь огляд: запустіть nvim, потім натисніть Пробіл, h, h.
- SPC h h Відкрити цей індекс команд
- SPC P Оглядач планів
- SPC m p Попередній перегляд Markdown у браузері
- SPC m r Відтворення Markdown у буфері
- <C-a> Виділити весь файл
- SPC y Копіювати до системного буфера обміну
- SPC t f Знайти файли
- SPC t t Живий пошук у проєкті
- SPC x Запустити або переглянути поточний файл
- SPC n Дерево файлів
- SPC t h Вибрати кольорову тему
- і всі інші прив’язки, завжди актуальні
Що ви отримуєте
Пʼять можливостей, кожна — на відстані одного натискання клавіші.
| Можливість | Клавіші | Що робить |
|---|---|---|
| Згенерований індекс команд | SPC h h |
Кожна привʼязка конфігурації, створена з актуальних розкладок клавіш. |
| Жести у стилі VS Code | <C-a>, SPC y |
Виділення всього файлу однією клавішею та копіювання до системного буфера обміну. Звичайна y теж копіює туди, бо буфер обміну спільний для всієї системи; там, де немає інструмента для буфера обміну (контейнер, SSH-сесія), копія передається через OSC 52. |
| Оглядач планів Deep Work Plan | SPC P |
Бічна панель за планами вашого репозиторію, згрупованими за станом і з індикаторами прогресу; клацніть план, щоб відкрити його режим читання. |
| Переглядач Markdown | SPC m p, SPC m r |
Попередній перегляд Markdown у браузері або відтворення в буфері. |
| Перевірений інсталятор | — | Самодостатній інсталятор для macOS, Linux і WSL із задокументованим ручним шляхом для Windows. |
Плани, не виходячи з редактора
SPC P, :DwpPlans або клацання по сегменту рядка стану відкриває бічну панель планів. Вона охоплює кожну теку .dwp/plans/ у поточному каталозі та в каталозі конфігурації Neovim і групує плани, починаючи з тих, що потребують найбільше уваги. У редакторі мітки такі: Working, Needs attention, Ready, Not started і Done. Для кожного плану показано індикатор прогресу.
Клацніть план або натисніть на ньому Enter, щоб відкрити режим читання: мету одним реченням, стан і прогрес, список завдань із позначеним поточним завданням і зрозумілі переходи до файлів самого плану. Рядок стану показує поточний активний план, а стартовий екран перелічує перші три. Ці інтерфейси пояснюють плани й ніколи нічого не записують у .dwp/.
Бічна панель реагує і на мишу, і на клавіатуру. Маленька стрілка біля плану показує або ховає його завдання та файли, а клацання по завданню чи файлу відкриває його. j, k, стрілки, Ctrl-n і Ctrl-p переходять від плану до плану, пропускаючи порожні рядки та оздоблення. Кожна секція показує свою кількість, кольори станів позначають піктограму та індикатор прогресу, живі плани мають виразні заголовки, а завершені — приглушені, а група Done із понад шістьма планами відкривається згорнутою. Вікно лише для читання й тихе: клавіші редагування нічого не роблять замість того, щоб виводити помилку.
Плани та дерево файлів працюють по черзі: відкриття однієї бічної панелі закриває іншу, тож ви дивитеся на одне за раз. Режим читання закривається разом із бічною панеллю планів. Чи закриває відкриття однієї бічної панелі іншу, задає ключ sidebars.exclusive у dwpvim.json.
План-оркестратор — провідний агент, що координує лінії в інших репозиторіях, — також отримує подання ліній лише для читання: :DwpLanes або L у бічній панелі планів. Воно читає таблиці ліній плану й показує поточний стан кожної лінії з herdr-peers lanes; якщо жоден Herdr недоступний, воно повідомляє про це й показує лише таблиці. Див. Запуск багатьох агентів.
Щоб читати Markdown-файли плану на місці, SPC m p показує поточний буфер у браузері, а SPC m r відтворює його всередині буфера. Обидва працюють лише в буферах Markdown.
Стартова панель
Стартовий екран — власний для DeepWorkPlan Vim. Він показує логотип Deep Work Plan, награвійований символами Брайля, із крихітним VIM під літерою P, нижче — підпис «powered by Dailybot», а праворуч — гравійовану сцену: маяк Deep Work Plan і корабель, що пливе в його морі. Промінь повільно пульсує, поки панель на екрані; щоб вимкнути це, задайте vim.g.dwp_greeter_pulse = false.
Сцена має шість висот, які вибираються за кількістю вільних рядків вікна. У вужчому вікні назва накладається на сцену зверху або стоїть сама. У широких вікнах скорочення та «Your plans» показано поруч, у вузьких — одне під одним. Натисніть Enter, щоб активувати рядок під курсором; SPC P відкриває бічну панель планів.
Налаштування бічних панелей
Файл dwpvim.json задає, з якого боку розташовано дві бічні панелі та яка в них ширина. Файл у каталозі редактора (~/.config/nvim) діє для всіх проєктів, а .dwpvim.json у каталозі, де ви запускаєте Neovim, перевизначає його для цього проєкту. Налаштування читаються під час запуску, тож після редагування файлу перезапустіть Neovim.
{
"tree": { "side": "left", "width": 40 },
"plans": { "side": "left", "width": 48 },
"sidebars": { "exclusive": true }
}
| Ключ | Значення | За замовчуванням | Що робить |
|---|---|---|---|
tree.side |
"left" або "right" |
"left" |
Бік дерева файлів (SPC n) |
tree.width |
ціле число від 20 до 120 | 40 |
Максимальна ширина дерева; воно все одно стискається до свого вмісту |
plans.side |
"left" або "right" |
"left" |
Бік бічної панелі планів (SPC P) |
plans.width |
ціле число від 20 до 120 | 48 |
Максимальна ширина бічної панелі планів |
sidebars.exclusive |
true або false |
true |
Одна бічна панель за раз; false дозволяє залишати відкритими обидві |
Відсутній файл — не проблема. Файл, що не є коректним JSON, невідомий ключ або недійсне значення ігноруються й повідомляються, але ніколи не призводять до збою. Виконайте :DwpConfig, щоб побачити всі чинні значення, файл, з якого вони взяті, і будь-яку виявлену проблему.
Легший редактор
Версія 0.6.0 прибирає те, чим ніхто не користувався, тож залишається менше плагінів для фіксації та менше пакетів для встановлення й оновлення під час першого запуску:
- Одинадцять мовних серверів Mason виведено з обігу: efm, diagnosticls, tailwindcss, grammarly, bashls, а також сервери для astro, svelte, Vue 2, Angular, SQL і Vim script.
- nvim-lint видалено, бо жодного лінтера ніколи не було налаштовано.
- Записи форматувальника prettier видалено, бо ніщо не встановлювало prettier.
:Formatзберігає biome, black, shfmt і stylua. - marksman залишається для переходу за посиланнями, доповнення посилань і заголовків та структури документа, із вимкненою діагностикою. Markdown навмисно залишається без форматувальника.
Вмикаються лише сервери, перелічені в конфігурації, навіть якщо Mason ще зберігає інші від попереднього налаштування. Кожен плагін, сервер та інструмент із причиною його наявності перелічено в PLUGINS.md.
Встановлення
Встановлення — це три команди: завантажте скрипт, звірте його з SHA-256 файлу, який роздає цей сайт, а потім запустіть. Інсталятор фіксує власний реліз, тож встановлює саме v1.0.1 — реліз, який описує ця сторінка, якщо ви не оберете іншу версію.
curl -fsSL -o install.sh https://deepworkplan.com/vim/install.sh && \
echo "24a550239108a71434e993675389c27c64d88c4c07af8efc9be98d23897fb716 install.sh" | shasum -a 256 -c && \
bash install.sh Перевірте перед запуском
Хочете спершу прочитати? Завантажте скрипт, перевірте його відбиток, прочитайте та лише потім запускайте.
- Завантажте скрипт
curl -fsSL https://deepworkplan.com/vim/install.sh -o install.sh - Виведіть його SHA-256 і порівняйте зі значенням нижче
sha256sum install.sh - Прочитайте скрипт
less install.sh - Запустіть скрипт
bash install.sh
- SHA-256 скрипта, який віддається зараз
24a550239108a71434e993675389c27c64d88c4c07af8efc9be98d23897fb716- 46504 байтів · 1109 рядків
У macOS на другому кроці використовуйте shasum -a 256 install.sh.
Щоб вибрати версію, передайте --version або задайте DWP_VIM_VERSION: точну версію, нижню межу '>=' або latest. DWP_VIM_REF приймає гілку або коміт. Старі релізи можуть не містити всіх можливостей, описаних на цій сторінці.
У Windows ці команди не застосовуються; ручний шлях описано в README репозиторію. Шлях встановлення для Windows
По порядку інсталятор:
- Перевіряє вашу ОС і менеджер пакетів та встановлює git, curl і інтерпретатор Lua, якщо чогось бракує (з
--skip-packages— нічого). - Визначає версію: власний реліз або той, який запитано через
--version. - З
--nvim X.Y.Zвстановлює цей реліз Neovim у~/.local/optі перевіряє його за SHA-256, який публікує Neovim. - Питає, перш ніж торкатися наявної конфігурації Neovim. Без терміналу зупиняється й нічого не змінює, якщо тільки
--yesне вказує йому відсунути цю конфігурацію вбік. - Клонує репозиторій у
~/.config/nvimабо оновлює його, якщо він уже там. - Запускає власний
lua install.luaрепозиторію. - Встановлює плагіни у фоновому режимі й перевіряє їх, тож виходити й відкривати заново не потрібно. З
--strictневдале чи неповне встановлення плагінів є помилкою.
Скрипт, що роздається тут, є побайтово ідентичною копією install.sh на тезі v1.0.1. Його контрольна сума роздається поруч, за адресою 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, щоб побачити всі параметри.
Вибір версії
За замовчуванням інсталятор встановлює власний реліз, v1.0.1. Щоб обрати інший, задайте DWP_VIM_VERSION або передайте --version: обидва способи роблять одне й те саме, тож використовуйте той, що краще читається; прапорець має пріоритет над змінною середовища. Кожен приймає:
| Форма | Приклад | Встановлює |
|---|---|---|
| Точна версія | 1.0.0 або v1.0.0 |
Цей реліз |
| Мінімальна межа | '>=0.4.2' |
Найновіший стабільний реліз, не нижчий за межу |
| Найновіша | latest |
Найновіший стабільний реліз |
Після завантаження та перевірки контрольної суми, описаних вище:
# exact version
DWP_VIM_VERSION=1.0.0 bash install.sh
bash install.sh --version 1.0.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 1.0.0 --nvim 0.12.5 --skip-packages --strict
--version 1.0.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завершується з ненульовим кодом, якщо встановлення плагінів у фоновому режимі не вдалося або залишило плагіни відсутніми. Він також перевіряє, що кожен плагін і pckr перебувають на коміті, закріпленому випуском уpckr/lockfile.lua.
Кожен прапорець має відповідник у вигляді змінної середовища (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, клонуйте тег
v1.0.1у%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.5.1
Щоб видалити, виконайте 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 без явного схвалення і ніколи не є обовʼязковим.
Як ним користуються програмувальні агенти?
Його створено для людей і для програмувальних агентів, що живуть у терміналі. Його привʼязки клавіш зафіксовано контрактними тестами, тому мʼязова памʼять і очікування агента переживають оновлення.
Яку версію я отримаю?
Інсталятор встановлює реліз, до якого належить, — сьогодні це v1.0.1, — якщо ви не оберете інший через --version або DWP_VIM_VERSION: точну версію, межу >= або latest. DWP_VIM_REF приймає гілку чи коміт; DWP_VIM_REF=main відстежує main. Ця сторінка описує реліз v1.0.1, який містить усі перелічені тут можливості.
Під якою ліцензією він і звідки походить?
GPL-3.0. Він походить від mu-vim Andrés M Prieto, а вказівка авторства залишається в репозиторії.
Вихідний код і ліцензія
Вихідний код міститься в репозиторії DeepWorkPlan Vim. Він відкритий і поширюється за ліцензією GPL-3.0, походить від mu-vim.
Повʼязані записи набору
- Devcontainer — відтворюване середовище розробки (перший аддон)
- Dailybot — звітування про життєвий цикл плану, видиме команді (другий аддон)
- AI Diff Reviewer — локальний перегляд під час фінальних перевірок плану (пʼятий аддон)
- Herdr — делегування завдання рівноправному агенту в панелі Herdr (v7)
- Agentkit — одна команда для кожного термінального програмувального агента та делегування в headless-режимі (v7)