Skip to content
← Retour au kit

DeepWorkPlan Vim

DeepWorkPlan Vim est l’éditeur de terminal de Deep Work Plan : une configuration Neovim pour les personnes, et pour les agents de programmation, qui travaillent dans un terminal. Vos plans, votre documentation et un index de toutes les commandes sont à une touche de distance.

C’est un produit distinct, proposé comme l’addon optionnel vim de Deep Work Plan v7 (v7.0.0). Deep Work Plan fonctionne avec n’importe quel éditeur ou sans éditeur, et l’éditeur n’exige pas Deep Work Plan : vous l’ajoutez à une machine séparément, et il fonctionne comme éditeur qu’un plan existe ou non. Cette page décrit la version v0.5.0.

Pourquoi un éditeur de terminal pour Deep Work Plan

Un Deep Work Plan est un dossier de Markdown sous .dwp/plans/ : un objectif, des tâches atomiques, des portes de validation et un journal continu. Les personnes le relisent, les agents l’exécutent, et les uns comme les autres le font souvent depuis un terminal. Un éditeur conçu pour ce travail garde trois choses à portée de main : le plan lui-même, la documentation qui l’entoure et les touches qui vous font passer de l’un à l’autre.

DeepWorkPlan Vim est cet éditeur. C’est une configuration Neovim soignée — serveurs de langage, complétion, linting, formatage, recherche floue, une arborescence de fichiers et des thèmes de couleurs choisis, chargés à la demande — plus les quelques surfaces qui en font l’éditeur de Deep Work Plan.

La visite : un index des commandes qui ne peut pas dériver

Appuyez sur SPC h h (Espace est la touche leader), ou lancez :DwpCommands, et l’éditeur liste tous ses raccourcis avec une description d’une ligne. La liste est générée à partir des raccourcis actifs : un raccourci défini n’importe où apparaît dans l’index sans être enregistré, et l’index ne peut pas devenir obsolète.

C’est toute la visite : lancez nvim, puis appuyez sur Espace, h, h.

Ce que vous obtenez

Cinq fonctions, chacune à une touche de distance.

Fonction Touches Ce qu’elle fait
Index des commandes généré SPC h h Tous les raccourcis de la configuration, générés à partir des raccourcis actifs.
Gestes à la VS Code <C-a>, SPC y Sélectionnez tout le fichier en une touche et copiez dans le presse-papiers du système. Un simple y y atterrit aussi, car le presse-papiers est celui du système.
Navigateur de plans Deep Work Plan SPC P Une barre latérale sur les plans de votre dépôt, regroupés par statut avec des barres de progression, et un lecteur pour un plan.
Visionneuse Markdown SPC m p, SPC m r Prévisualisez le Markdown dans le navigateur ou affichez-le dans le tampon.
Installateur vérifié — Un installateur autonome pour macOS, Linux et WSL, avec une procédure manuelle documentée pour Windows.

Les plans sans quitter l’éditeur

SPC P, :DwpPlans ou un clic sur le segment de la ligne d’état ouvre la barre latérale des plans. Elle couvre chaque dossier .dwp/plans/ du répertoire courant et du répertoire de configuration de Neovim, et classe les plans en commençant par ceux qui demandent le plus d’attention. Dans l’éditeur, les libellés sont Working, Needs attention, Ready, Not started et Done. Chaque plan affiche une barre de progression.

Appuyez sur Entrée sur un plan pour ouvrir le lecteur : l’objectif en une phrase, le statut et la progression, la liste des tâches avec la tâche en cours marquée, et des accès en langage clair aux fichiers du plan. La ligne d’état affiche le plan actif en direct, et l’écran d’accueil liste les trois premiers. Ces surfaces expliquent les plans ; elles n’écrivent jamais sous .dwp/.

Pour lire sur place les fichiers Markdown d’un plan, SPC m p prévisualise le tampon courant dans le navigateur et SPC m r l’affiche dans le tampon. Les deux ne fonctionnent que dans les tampons Markdown.

Installation

L’installation tient en trois commandes : téléchargez le script, vérifiez-le avec le SHA-256 du fichier que sert ce site, puis exécutez-le. L’installateur fige sa propre version : il installe donc exactement v0.5.0, la version que décrit cette page, sauf si vous choisissez une autre version.

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

Inspecter avant d’exécuter

Vous préférez lire d’abord ? Téléchargez le script, vérifiez son empreinte, lisez-le, puis exécutez-le.

  1. Télécharger le script
    curl -fsSL https://deepworkplan.com/vim/install.sh -o install.sh
  2. Afficher son SHA-256 et le comparer à la valeur ci-dessous
    sha256sum install.sh
  3. Lire le script
    less install.sh
  4. Exécuter le script
    bash install.sh
SHA-256 du script servi actuellement
4890c140528d6b8d19b6bbc4102051e0b9dce2e26f43a693bdeab2e1cd8e196b
42510 octets · 1017 lignes

Sous macOS, utilisez shasum -a 256 install.sh pour la deuxième étape.

Pour choisir une version, passez --version ou définissez DWP_VIM_VERSION : une version exacte, un minimum '>=' ou latest. DWP_VIM_REF accepte une branche ou un commit. Les anciennes versions peuvent ne pas inclure toutes les fonctions décrites sur cette page.

Sous Windows, ces commandes ne s’appliquent pas ; le README du dépôt décrit la procédure manuelle. Procédure d’installation sous Windows

Dans l’ordre, l’installateur :

  1. Vérifie votre système et votre gestionnaire de paquets, et installe git, curl et un interpréteur Lua s’il en manque (aucun avec --skip-packages).
  2. Résout la version : sa propre version, ou celle que demande --version.
  3. Avec --nvim X.Y.Z, installe cette version de Neovim dans ~/.local/opt, vérifiée avec le SHA-256 que publie Neovim.
  4. Demande avant de toucher à une configuration Neovim existante. Sans terminal, il s’arrête et ne change rien, sauf si --yes lui indique de mettre cette configuration de côté.
  5. Clone le dépôt dans ~/.config/nvim, ou le met à jour s’il s’y trouve déjà.
  6. Exécute le propre lua install.lua du dépôt.
  7. Installe les extensions en mode headless et les vérifie, donc sans étape de fermeture et de réouverture. Avec --strict, une installation d’extensions échouée ou incomplète est une erreur.

Le script servi ici est une copie identique octet pour octet de install.sh à l’étiquette v0.5.0. Sa somme de contrôle est servie à côté, à https://deepworkplan.com/vim/install.sh.sha256, ce qui vous permet de vérifier le téléchargement avec shasum -a 256 -c install.sh.sha256 (sous Linux, sha256sum -c install.sh.sha256). Pour une vérification depuis une seconde origine, comparez-la avec la ligne install.sh de SHA256SUMS dans la version publiée sur GitHub. Exécutez bash install.sh --help pour lister toutes les options.

Choisir une version

Par défaut, l’installateur installe sa propre version, v0.5.0. Pour en choisir une autre, définissez DWP_VIM_VERSION ou passez --version : les deux font la même chose, utilisez donc celui qui se lit le mieux ; une option l’emporte sur l’environnement. Chacun accepte :

Forme Exemple Installe
Version exacte 0.5.0 ou v0.5.0 Cette version
Version minimale '>=0.4.2' La version stable la plus récente égale ou supérieure au minimum
Plus récente latest La version stable la plus récente

Après le téléchargement et la vérification de la somme ci-dessus :

# 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

Mettez le minimum entre guillemets, afin que le shell n’interprète pas > comme une redirection. Les versions ne se résolvent qu’en étiquettes de versions stables. Pour une branche ou un commit, définissez plutôt DWP_VIM_REF (DWP_VIM_REF=main suit main) ; une version et une référence qui ne concordent pas constituent une erreur.

Conteneurs et CI

Dans une image ou un job de CI, où il n’y a pas de terminal et souvent pas de root, téléchargez et vérifiez le script, puis exécutez-le en une seule étape avec des options qui rendent le résultat reproductible :

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 fige la version de l’éditeur.
  • --nvim 0.12.5 installe cette version de Neovim dans ~/.local/opt/nvim-v0.12.5, liée en tant que ~/.local/bin/nvim et vérifiée avec le SHA-256 que publie Neovim (Linux et macOS).
  • --skip-packages n’installe aucun paquet système : l’image doit déjà fournir git, curl et Lua.
  • --strict se termine avec un code non nul lorsque l’installation headless des extensions échoue ou laisse des extensions manquantes.

Chaque option a un équivalent en variable d’environnement (DWP_VIM_VERSION, DWP_VIM_NVIM, DWP_VIM_SKIP_PACKAGES=1, DWP_VIM_STRICT=1). Ajoutez --yes uniquement lorsque l’image peut déjà contenir une configuration Neovim à mettre de côté.

Prérequis et plateformes

  • Neovim 0.12 ou plus récent. Installez-le vous-même, ou laissez l’installateur ajouter une version vérifiée avec --nvim X.Y.Z (Linux et macOS).
  • Lua : lua, lua5.4 ou luajit. L’installateur en ajoute un s’il manque.
  • macOS, Linux et WSL exécutent l’installateur. Windows dispose d’une procédure manuelle documentée dans le README du dépôt : installez Neovim avec winget, clonez l’étiquette v0.5.0 dans %LOCALAPPDATA%\nvim et exécutez lua install.lua depuis Git Bash.
  • Sous licence GPL-3.0 : libre d’utilisation, d’étude et de modification.

Mettre à jour, figer une version et désinstaller

Pour mettre à jour, exécutez l’installateur d’une version plus récente, ou exécutez bash install.sh --version latest. Le relancer fait passer une installation existante de DeepWorkPlan Vim à la version choisie, conserve vos branches et n’écrase jamais les modifications locales : lorsque des modifications ou des commits locaux seraient perdus, il s’arrête et ne change rien.

Pour figer une version, utilisez --version (voir Choisir une version) ; pour une branche ou un commit, définissez DWP_VIM_REF. Préférez une version publiée : les versions antérieures à v0.4.0 n’incluent ni les gestes, ni le navigateur de plans, ni la visionneuse Markdown, ni cet installateur.

# 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

Pour désinstaller, exécutez lua delete.lua depuis le répertoire de configuration. Il supprime la configuration, les extensions, les données Mason, le cache et l’état, ainsi que la copie de police faite par l’installateur, et laisse intacts le binaire Neovim et vos paquets système.

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

Questions

Écrasera-t-il ma configuration Neovim ?

Non, pas sans votre accord. Quand il trouve une configuration qui n’est pas DeepWorkPlan Vim, une exécution interactive demande avant de la déplacer vers ~/.config/previous-deepworkplan-vim. Sans terminal, il s’arrête et ne change rien, sauf si vous passez --yes pour la mettre de côté sans intervention. Si ce chemin de sauvegarde existe déjà, il s’arrête toujours et ne change rien.

Fonctionne-t-il sous Windows ?

L’installateur ne s’exécute pas sous Windows. Utilisez la procédure manuelle du README du dépôt, ou exécutez l’installateur dans WSL.

Ai-je besoin de Deep Work Plan pour l’utiliser ?

Non. C’est d’abord un éditeur. Il n’installe pas la skill Deep Work Plan et ne l’exige pas ; le navigateur de plans n’a simplement rien à lister tant qu’aucun dossier .dwp/plans/ n’existe.

Comment l’addon vim de la v7 l’utilise-t-il ?

Deep Work Plan v7 propose l’éditeur comme l’addon optionnel vim pendant l’onboarding. L’addon détecte une installation existante en lecture seule, via le fichier addon/surface.json de l’éditeur, et ne propose l’installation figée et vérifiée par somme de contrôle qu’avec votre consentement. Il n’écrase jamais une configuration Neovim existante sans approbation explicite, et il n’est jamais requis.

Comment les agents de programmation l’utilisent-ils ?

Il est conçu pour les personnes et pour les agents de programmation qui vivent dans un terminal. Ses raccourcis sont figés par des tests de contrat : la mémoire musculaire, comme les attentes d’un agent, survivent aux mises à jour.

Quelle version obtiens-je ?

L’installateur installe la version à laquelle il appartient — v0.5.0 aujourd’hui — sauf si vous en choisissez une autre avec --version ou DWP_VIM_VERSION : une version exacte, un minimum >= ou latest. DWP_VIM_REF accepte une branche ou un commit ; DWP_VIM_REF=main suit main. Cette page décrit la version v0.5.0, qui inclut toutes les fonctions listées ici.

Sous quelle licence est-il et d’où vient-il ?

GPL-3.0. Il dérive de mu-vim, d’Andrés M Prieto, et la mention de l’auteur reste dans le dépôt.

Code source et licence

Le code source se trouve dans le dépôt DeepWorkPlan Vim. Il est public et sous licence GPL-3.0, dérivé de mu-vim.

Entrées du kit associées

  • Devcontainer — environnement de développement reproductible (premier addon)
  • Dailybot — rapports de cycle de vie du plan visibles par l’équipe (deuxième addon)
  • AI Diff Reviewer — revue locale pendant les Final Reviews du plan (cinquième addon)
  • Herdr — déléguer une tâche à un agent pair dans un panneau Herdr (v7)
  • Agentkit — une seule commande pour chaque agent de programmation en terminal, et la délégation headless (v7)