Skip to main content

dev_prune/
help.rs

1// Copyright 2026 VKrishna04
2// SPDX-License-Identifier: Apache-2.0
3
4// The long-form help text: what `devp <command> --help` prints.
5//
6// `-h` stays short — one line per flag, no scrolling. `--help` (and `devp help
7// <command>`) gets these: the full description, the behaviour that is not obvious from
8// the flag list, and worked examples for every command and subcommand. The text is
9// kept in one file rather than inline in the derive so the CLI definition in `lib.rs`
10// stays readable, and because these paragraphs are documentation first — they carry
11// the same facts as `docs/CLI_REFERENCE.md`, and changing one means changing both.
12
13pub const INIT_LONG: &str = "\
14Crawl the given directory trees for Git repositories and register every one found, up \
15to 8 levels deep. Registration is one entry in dev-prune's own registry file — nothing \
16in the repository is created, changed or deleted.
17
18After registering, it runs the same integration pass as `devp setup` (installing \
19whatever is missing, reporting whatever it skipped) and the same quiet release check \
20as `devp update`.
21
22`--auto` works the paths out instead of being told them: the directories your \
23registered repositories already sit in, the workspace you are standing in, and the \
24conventional locations under your home directory. It is the form to use when nobody \
25has said where the code is — an assistant setting the tool up, or a machine whose \
26repositories you would rather not list by hand.
27
28A bulk scan skips any repository holding an `ignore.devprune.json`, so a repository can \
29decline before it is ever registered. `devp link <path>` still registers it, because \
30naming one repository is not a bulk scan.
31
32Registration is what makes a repository visible to `devp run`, `devp status` and the \
33background pass. Registering is not pruning: a registered repository is still only \
34touched once it is idle, and only where a lockfile proves the directory can be rebuilt.";
35
36pub const INIT_EXAMPLES: &str = "\
37EXAMPLES:
38  devp init                       Register repositories under the current directory
39  devp init --auto                Work out where the repositories are and register them
40  devp init --auto --dry-run      Show what that would register, write nothing
41  devp init ~/Code                Register everything under ~/Code
42  devp init ~/Code ~/Work/oss     Multiple trees in one pass
43  devp scan ~/Code                Same command — `scan` and `onboard` are aliases
44  DEV_PRUNE_NO_AUTO_SETUP=1 devp init ~/Code
45                                  Register repositories, install nothing
46
47OPTING OUT:
48  ignore.devprune.json            A file by that name in a repository keeps it out,
49                                  both of a bulk scan and of every prune pass
50
51UNDO:
52  devp undo                       Reverts the most recent init or link";
53
54pub const LINK_LONG: &str = "\
55Register one Git repository for pruning. The path defaults to `.`, so inside a \
56repository `devp link` is the whole command. Registration writes one entry to \
57dev-prune's registry; the repository itself is untouched.
58
59`--quiet` is the form the global Git hook invokes: it prints nothing (a hook fires \
60inside someone's commit, whose terminal is not dev-prune's to write to) and it skips \
61repositories whose `.devprune.json` sets `disable_hooks`, so a workspace that opted \
62out of auto-registration stays out.";
63
64pub const LINK_EXAMPLES: &str = "\
65EXAMPLES:
66  devp link                       Register the current directory
67  devp link ~/Code/my-app         Register a repository by path
68  devp link . --quiet             What the Git hook runs; silent, honours opt-outs
69
70UNDO:
71  devp undo                       Reverts the most recent init or link
72  devp unlink                     Unregister (keeps every file on disk)";
73
74pub const UNLINK_LONG: &str = "\
75Remove a repository from dev-prune's registry. This deletes the registry entry and \
76nothing else — no workspace file is touched, and the repository's `.devprune.json`, \
77if it has one, stays where it is.
78
79`--missing` removes every registered path whose directory no longer exists, instead \
80of one named repository. Deleted clones, reformatted drives and moved workspaces all \
81leave dead entries behind; `devp doctor` counts them in one warning and points here \
82rather than printing one `devp unlink` line per dead path.";
83
84pub const UNLINK_EXAMPLES: &str = "\
85EXAMPLES:
86  devp unlink                     Unregister the current directory
87  devp unlink ~/Code/old-app      Unregister a repository by path
88  devp unlink --missing           Drop every entry whose path no longer exists";
89
90pub const UNDO_LONG: &str = "\
91Revert the most recent `devp init` or `devp link`: whatever repositories that one \
92action registered are unregistered again. Only registration is undone — `undo` never \
93deletes files, and it is not the undo for a prune (that is `devp restore --last-run`).";
94
95pub const UNDO_EXAMPLES: &str = "\
96EXAMPLES:
97  devp undo                       Unregister whatever the last init/link registered
98
99RELATED:
100  devp restore --last-run         The undo for a prune pass — reinstalls what it deleted";
101
102pub const RUN_LONG: &str = "\
103Execute a prune pass: across every registered repository with no path, or on one \
104repository with `devp run <path>`. Each repository goes through the same gauntlet, \
105and a directory is deleted only when every check passes:
106
107  1. `ignore.devprune.json` in the root, or `\"ignore\": true` — skipped instantly.
108  2. Idle check: last commit and newest source mtime, against `idle_days` (15 by
109     default). `--ignore-idle` lifts this one check and nothing else.
110  3. Project discovery: the root and up to `scan_depth` levels below it (6 by
111     default), so a monorepo's every package is found.
112  4. The package manager's own binary must be present — a directory whose manager
113     is missing cannot be verified, so it is not touched.
114  5. Lockfile verification: the manager itself confirms the lockfile can rebuild
115     the directory. No flag bypasses this, and none ever will.
116  6. Size floor (`min_size_mb` / `--min-size`), symlink refusal, nested-repository
117     refusal.
118
119Interactively, a registry-wide pass opens a selection TUI showing what would be \
120deleted before anything is; a targeted `devp run <path>` lists every directory with \
121its size and the total, notes that `devp restore` brings it back, and asks. Either \
122way `-y` skips the confirmation, `--dry-run` reports what a pass would do without \
123deleting anything at all, and without a terminal the run exits with an error naming \
124`--yes` rather than waiting on a prompt. Adapter names for `--only`/`--skip` are: npm, pnpm, yarn, bun, uv, \
125poetry, pdm, pipenv, venv, cargo, go, composer, bundler, cocoapods, mix, mix_build, \
126gradle, maven, swift, terraform, dart, vcpkg, cmake_build — an unknown name is an \
127error listing the valid ones, not a silently empty pass. cargo, gradle, maven, \
128swift, dart, mix_build, vcpkg and cmake_build are opt-in (`devp config set \
129enable_cargo true`) and idle-gated separately by `build_idle_days`, because a \
130build directory takes far longer to get back than a dependency directory. \
131`devp config wizard` switches them on by language, and can give any one adapter \
132its own idle window.
133
134`--except` is the safe spelling of \"clean up but keep the API project\": the named \
135repositories are never verified, never deleted and never restored, which beats \
136pruning them and downloading everything back. Entries match by full path or by \
137directory name, case-insensitively, `~` expanded.
138
139`--explain` answers \"why was that repository not pruned?\": every repository and \
140directory is listed with its verdict, including the states a normal pass keeps quiet \
141about — still active (with the actual age), opted out, under the size floor. It is \
142read-only and cannot be combined with `--json`.";
143
144pub const RUN_EXAMPLES: &str = "\
145EXAMPLES:
146  devp run --dry-run              What would be pruned, and why the rest would not
147  devp run                        Prune across all registered repositories (asks first)
148  devp run -y                     Same, no confirmation prompt
149  devp run .                      Prune only the current repository (asks first)
150  devp run ~/Code/my-app --ignore-idle -y
151                                  Prune it even though it was touched recently
152  devp run --except api-service,~/Code/playground
153                                  Everything except the ones you name
154  devp run --only cargo,uv --dry-run
155                                  Only these package managers
156  devp run --skip venv --min-size 50
157                                  Skip venvs; ignore directories under 50 MiB
158  devp run --json --dry-run       One JSON document on stdout (schema in CLI_REFERENCE)
159  devp run --explain              Why each repository would or would not be pruned
160
161Run interactively with a terminal, `--json` also copies the document to the clipboard.
162A run in which any repository failed exits 1, even if others succeeded.";
163
164pub const STATUS_LONG: &str = "\
165The dashboard: every registered repository with its state (Candidate, Active, \
166Ignored, No Bloat, Path Missing, or an unreadable `.devprune.json`), its reclaimable \
167space, and its last activity. In a terminal this is an interactive TUI; piped or \
168redirected it prints a plain table; `--json` replaces either with one document and \
169changes nothing at all.
170
171Sizes are what deleting the directory actually gives back: bytes hardlinked into a \
172pnpm or bun store are measured per file and excluded, because the store keeps them.
173
174TUI KEYS:
175  Up/Down, j/k      Move           PgUp/PgDn        Jump ten rows
176  Home/End, g/G     First/last     p                Prune-select mode (candidates pre-selected)
177  Space             Toggle row     a                Toggle all candidates
178  Enter             Prune the selection             i    Toggle ignore in .devprune.json
179  Esc               Leave mode / exit               q, Ctrl-C   Exit
180
181SHORTCUTS:
182  devp status daemon              = devp config daemon status
183  devp status . hook              = devp config hook . status";
184
185pub const STATUS_EXAMPLES: &str = "\
186EXAMPLES:
187  devp status                     The dashboard (TUI in a terminal, table when piped)
188  devp status --top 10            Only the ten biggest repositories; totals unaffected
189  devp status --drift             What would a prune refuse on, and how to record it
190  devp status --json | jq '.totals.reclaimable_bytes'
191                                  Machine-readable; stdout carries the document only
192  devp status --top 5 --json      The trim is reported as a top-level \"top\" field
193
194Run interactively with a terminal, `--json` also copies the document to the clipboard.";
195
196pub const STATS_LONG: &str = "\
197What dev-prune has already done, as opposed to what it could do next: lifetime space \
198reclaimed, how many prune passes there have been, the most recent pass and how to \
199undo it, the last passes, and the repositories that have given back the most. \
200Read-only — it reads the registry and touches nothing.";
201
202pub const STATS_EXAMPLES: &str = "\
203EXAMPLES:
204  devp stats                      The report
205  devp stats --json | jq '.lifetime.bytes_freed'
206                                  Lifetime bytes as a number
207
208Run interactively with a terminal, `--json` also copies the document to the clipboard.";
209
210pub const MAN_LONG: &str = "Render the manual, from the same clap definitions `--help` prints, so the manual cannot describe a flag the program does not have.
211
212`devp man` at a terminal prints the contents page: every command grouped by what it is for, one line each, plus the flags that go before the command and the exit codes. `devp man <command>` prints that one command's page — the same text `devp <command> --help` prints, because they are the same definition.
213
214The roff source is something `man` formats, not something a person reads, and on Windows there is no `man` to hand it to, so it appears only where something can use it: redirect or pipe the output and it is roff again, so `devp man > devp.1` and `devp man | man -l -` are unchanged. `--roff` forces roff at a terminal too.
215
216`--dir` writes the full set (`devp.1`, `dev-prune.1`, and one `devp-<command>.1` per subcommand) into a directory, ready to copy onto `manpath`.";
217
218pub const MAN_EXAMPLES: &str = "EXAMPLES:
219  devp man                        The contents page, on any platform
220  devp man run                    One command's page
221  devp man | man -l -             Read it formatted by man (Linux/macOS)
222  devp man --roff > devp.1        Save the roff source
223  devp man run --roff > devp-run.1   Save one page's roff source
224  devp man --dir ./man            Write the full set into ./man
225  sudo cp man/*.1 /usr/local/share/man/man1/   Install them system-wide";
226
227pub const COMPLETIONS_LONG: &str = "\
228Print a shell completion script to stdout — the script and nothing else, because the \
229output is meant to be redirected or eval'd and anything extra becomes a shell error \
230on every new terminal.
231
232The script is generated from the same argument definition the binary parses with, so \
233a flag cannot exist in one and be missing from the other. It completes whichever name \
234invoked it: `devp completions bash` completes `devp`, `dev-prune completions bash` \
235completes `dev-prune` — generate one for each name you actually type.";
236
237pub const COMPLETIONS_EXAMPLES: &str = "\
238EXAMPLES:
239  source <(devp completions bash)                       Bash, current shell
240  devp completions bash > ~/.local/share/bash-completion/completions/devp
241  devp completions zsh  > ~/.zfunc/_devp                Zsh (a directory on $fpath)
242  devp completions fish > ~/.config/fish/completions/devp.fish
243  devp completions powershell | Out-File -Append -Encoding utf8 $PROFILE
244                                                        PowerShell, permanently";
245
246pub const CACHES_LONG: &str = "\
247Find every package-manager cache and store on the machine, size each one, and print \
248the command that clears it — largest first, with a total. On its own it deletes \
249nothing, and nothing that runs on a schedule ever will: a cache is shared by every \
250repository, so no single lockfile can prove its contents recoverable, which is the \
251bar every dev-prune deletion has to clear. Clearing one also turns the next `devp \
252restore` into a download.
253
254`devp caches clear <manager>` runs the command this table prints, after showing you \
255what goes and asking.
256
257Covered: npm, pnpm, yarn, bun, uv, pip, conda, cargo, go, maven, gradle, nuget, vcpkg, \
258conan, composer, cocoapods and hex. Each manager is asked where its cache is (`npm \
259config get cache`, `go env GOMODCACHE`, …) rather than assumed, with read-only queries \
260run from your home directory; a manager that is not installed falls back to the \
261conventional location, because a cache left behind by an uninstalled manager is \
262exactly the multi-gigabyte directory nobody remembers.";
263
264pub const CACHES_EXAMPLES: &str = "\
265EXAMPLES:
266  devp caches                     The table, largest first, with clear commands
267  devp caches --json | jq '.summary.total_bytes'
268                                  Machine-readable
269  devp caches clear npm           Empty one, after asking
270  devp caches clear all --dry-run What would go, and nothing touched
271
272Run interactively with a terminal, `--json` also copies the document to the clipboard.";
273
274pub const CACHES_DOCKER_LONG: &str = "\
275What the engine is holding, in its own words: images, containers, local volumes and build cache, each with a count, a size, and how much of that size it believes it could give back. Then the commands that would give it back, narrowest first.
276
277Read-only, permanently. dev-prune deletes only what a lockfile proves it can rebuild, and nothing here clears that bar: an image's registry tag can be retagged or deleted, the Dockerfile that built it may not be on this disk, and a named volume is the one thing on the machine that is not reproducible at all. So this prints the prune commands and never runs them, with or without `--yes`.
278
279The numbers come from the engine's own `system df` rather than from a directory walk. On Docker Desktop and Podman the store lives inside a VM disk image the host cannot see, and `~/.docker` is configuration rather than data — a size taken off the filesystem would be wrong by orders of magnitude, in the reassuring direction. Asking the engine is also the only way to learn what is *reclaimable*, which is the figure that decides anything: 40 GB of images with 38 GB dangling is a different situation from 40 GB with 2 GB dangling.
280
281An engine that is installed with its daemon stopped is reported as exactly that, in the engine's own words, rather than as an absence.";
282
283pub const CACHES_CONTAINERS_LONG: &str = "\
284The same read-only report as `devp caches docker`, for every container engine on this machine — docker, podman and nerdctl — or for the one you name.
285
286Local Kubernetes clusters are listed by name and deliberately not sized. kind, k3d and minikube run their nodes as containers, or as a VM disk belonging to an engine already in the table, so their disk is counted there. A figure beside the cluster name would be the same gigabytes twice. Delete one with its own tool — `kind delete cluster`, `minikube delete`, `k3d cluster delete` — which is what actually releases the space. The cluster list is read out of your kubeconfig with `kubectl config get-contexts`, which contacts nothing: a context pointing at a production cluster is filtered out by name here rather than by being dialled.";
287
288pub const CACHES_CONTAINERS_EXAMPLES: &str = "\
289EXAMPLES:
290  devp caches docker              Images, containers, volumes, build cache
291  devp caches podman              The same, for Podman
292  devp caches containers          Every engine installed, plus local clusters
293  devp caches containers nerdctl  Just that one
294  devp caches docker --json | jq '.summary.reclaimable_bytes'
295                                  Machine-readable
296
297Nothing here deletes anything. The prune commands are printed for you to run.";
298
299pub const CACHES_CLEAR_LONG: &str = "\
300Empty one manager's cache, or every one of them. What is about to go is listed and \
301sized first, and unless `--yes` answers for you, it asks.
302
303This is a convenience, not automation. No scheduler, no Git hook and no `devp run` \
304will ever clear a cache — this only runs when you type it.
305
306Wherever the manager ships its own subcommand, that is what runs: `npm cache clean \
307--force`, `pnpm store prune`, `go clean -modcache`. The manager knows what is still \
308referenced, which a directory delete cannot work out, and its own bookkeeping stays \
309consistent. cargo, gradle, vcpkg and hex ship nothing equivalent, so those \
310are cleared by removing the directory this command resolved and sized — never a string \
311handed to a shell.
312
313Maven is reported and never cleared. `~/.m2/repository` is an install target as \
314well as a download cache — `mvn install:install-file` puts artifacts there that no \
315remote can hand back — so dev-prune sizes it and prints `rm -rf ~/.m2/repository` \
316for you to run. `clear maven` says so and stops; `clear all` skips it.
317
318Two flags narrow what `all` means, so you do not have to pick the caches by hand. \
319`--over-cap` keeps only the managers that have outgrown the ceiling you set in \
320`cache_max_gb`; with no cap set anywhere it clears nothing and says so. `--unused` keeps \
321only the managers that no registered repository uses — a cache with nothing behind it \
322was filled for projects that are not on this disk any more. It counts only repositories \
323dev-prune knows about, so `devp link` anything you keep outside the registry first, and \
324it refuses to run at all when there are no registered repositories to check against.
325
326Nothing else in a cache is lost; every manager re-downloads what it needs. What it costs \
327is time, in every project on the machine, on the next install and the next `devp \
328restore`. The freed size reported afterwards is measured rather than assumed, because \
329a `prune` keeps what is still in use.";
330
331pub const CACHES_CLEAR_EXAMPLES: &str = "\
332EXAMPLES:
333  devp caches clear npm           One manager, after confirming
334  devp caches clear cargo         Both cargo rows: the registry cache and its sources
335  devp caches clear all --dry-run Everything that would go, and nothing touched
336  devp caches clear all --over-cap
337                                  Only the ones past their cache_max_gb
338  devp caches clear all --unused  Only the ones no registered repository uses
339  devp caches clear all --yes     No prompt, for a script
340  devp caches clear go --json --yes
341                                  Machine-readable (`--json` requires `--yes`)
342
343Exit code 1 if any cache could not be cleared; the rows are printed either way.
344Exit code 2 for `maven`, which is reported but never cleared.";
345
346pub const TRUST_LONG: &str = "\
347What dev-prune is allowed to do on this machine, on one screen. Read-only — it reads \
348the registry and the OS and changes nothing.
349
350Two sections, and the split is the point. The first is guaranteed by the code: the \
351seven safety invariants plus the two questions asked as often as any of them — there \
352is no telemetry endpoint, and build output is never deleted. Those rows read the same \
353on every machine and have no setting and no flag behind them. The second is read live \
354off this machine: whether the scheduler is installed, whether the Git hooks register \
355repositories on their own, how many repositories are registered, and the settings that \
356widen what may happen without you asking for it.
357
358There is no letter grade. A report that says `trust level: MEDIUM` tells you nothing \
359you can act on, so the widened settings are named instead — `devp config show` has \
360every one of them, and `devp config set <key> <value>` puts one back.
361
362The long form of the guarantees is docs/SAFETY_INVARIANTS.md.";
363
364pub const TRUST_EXAMPLES: &str = "\
365EXAMPLES:
366  devp trust                      The report
367  devp trust --json | jq '.summary.widened'
368                                  Just the settings that widen what may happen
369  devp trust --json | jq -e '.summary.widened_count == 0'
370                                  Exit 1 from jq if this machine has widened anything
371
372Run interactively with a terminal, `--json` also copies the document to the clipboard.";
373
374pub const CONFIG_LONG: &str = "\
375Everything configurable lives under here: global settings (get/set/show/wizard), the \
376per-repository `.devprune.json` (project), the OS background scheduler (daemon), the \
377global Git auto-registration hooks (hook), and the file-manager icon registration \
378(icon).
379
380SHORTHANDS — `daemon`, `hook` and `icon` work without the leading `config`, and the \
381action words people reach for are accepted:
382  devp hook install       = devp config hook enable
383  devp hook uninstall     = devp config hook disable
384  devp daemon on / off    = devp config daemon enable / disable
385  devp icon               = devp config icon
386Accepted action words: enable/install/on, disable/uninstall/remove/off, status/show. \
387Anything else is rejected — a mistyped action never silently degrades into a status \
388report.";
389
390pub const CONFIG_EXAMPLES: &str = "\
391EXAMPLES:
392  devp config show                Every global setting and its value
393  devp config get idle_days       One setting
394  devp config set idle_days 30    Change it (rejects out-of-range values)
395  devp config recommended         Turn on everything the first run recommends
396  devp config wizard              Walk through every setting, Enter keeps the current
397  devp config project .           Inspect or create this repo's .devprune.json
398  devp config daemon status       Is the background pass scheduled?
399  devp config . daemon disable    Opt this repository out of the background pass
400  devp config hook enable --chain Take core.hooksPath, forwarding to the tool holding it
401  devp config icon                Register the .devprune.json icon and schema";
402
403pub const CONFIG_GET_LONG: &str = "\
404Print one global setting's current value. The keys, defaults and meanings:
405
406  idle_days                  15     Days untouched before a repo is a candidate
407  min_size_mb                0      Smallest directory worth deleting (0 = no floor)
408  scan_depth                 6      Directory levels below a repo root discovery descends (1-32)
409  require_confirmation       true   Whether a prune pass asks before deleting
410  allow_manifest_rewrite     false  Whether verification may repair a drifted lockfile
411  command_timeout_secs       600    Ceiling on any one package-manager command
412  auto_setup                 true   Whether the integration pass may run unattended
413  auto_daemon                true   …and may register the OS scheduler
414  check_interval_days        2      How often the scheduler runs a pass
415  auto_hooks                 true   …and may install the global Git hooks
416  auto_hooks_chain           false  …and may chain onto another tool's core.hooksPath
417  update_check               true   Whether the periodic release check runs
418  update_check_interval_days 7      Minimum gap between two release checks
419  update_check_timeout_secs  5      How long that one request may hang
420
421Three have a per-repository override in `.devprune.json`, where they win for that \
422tree only: `idle_days` (spelled `override_idle_days` there), `min_size_mb` and \
423`scan_depth`. The rest are deliberately global — a committed `.devprune.json` must \
424not be able to grant a repository `allow_manifest_rewrite` over its own manifests.";
425
426pub const CONFIG_GET_EXAMPLES: &str = "\
427EXAMPLES:
428  devp config get idle_days
429  devp config get update_check";
430
431pub const CONFIG_SET_LONG: &str = "\
432Change one global setting. A value outside the accepted range is rejected with the \
433range in the message, never silently clamped — `scan_depth 0` and `scan_depth 40` are \
434both refused outright. Keys are the same list `devp config get --help` shows.";
435
436pub const CONFIG_SET_EXAMPLES: &str = "\
437EXAMPLES:
438  devp config set idle_days 30
439  devp config set min_size_mb 50
440  devp config set command_timeout_secs 1200
441  devp config set update_check false    Turn the release check off for good";
442
443pub const CONFIG_SHOW_LONG: &str = "\
444Print every global setting with its current value. With `--update`, also run a sync \
445pass across all registered repositories, refreshing each one's `.devprune.json` \
446scaffolding without touching values you have changed.";
447
448pub const CONFIG_SHOW_EXAMPLES: &str = "\
449EXAMPLES:
450  devp config show
451  devp config show --update";
452
453pub const CONFIG_PROJECT_LONG: &str = "\
454Inspect a repository's `.devprune.json`, or create it when missing. The file holds \
455the per-repository overrides — `override_idle_days`, `min_size_mb`, `scan_depth`, \
456`ignore`, `disable_daemon`, `disable_hooks` — and carries a `$schema` line so any \
457editor with JSON Schema support validates and completes it.
458
459`--update` refreshes the file's scaffolding (schema pointer, missing keys) while \
460keeping every value you have set. A file that does not parse is refused, not reset — \
461fix it, or pass `--update` deliberately.
462
463Writing the file also records it in the repository's `.git/info/exclude`, so the \
464config — one machine's preference, not part of the project — never shows up in \
465`git status`. The shared, tracked `.gitignore` is never modified.
466
467`--team` addresses `project.devprune.json` instead: same keys, same schema, and \
468deliberately not excluded, because it is the half meant to be committed. Every key it \
469names wins over `.devprune.json`; every key it leaves out is still yours to answer. It \
470is created empty apart from the schema line for that reason. Nothing dev-prune writes \
471on your behalf ever edits it.
472
473Both files can also carry `prunable.directories`: directories no lockfile describes, \
474each with the `rebuild` command that puts it back. Unlike every other key, the two \
475files' lists add up rather than one winning — a team declaration never discards your \
476own. Before deleting one, dev-prune checks that it is inside the repository, that Git \
477is tracking nothing in it, and that the rebuild command's tool is on this machine.
478
479`prunable.exclude` lists declared paths to leave alone on this machine, whoever \
480declared them — how you keep a directory the committed file calls rebuildable without \
481editing a file the whole team shares. Spelled the same way as a `path`, and honoured \
482from whichever file names it, because a veto only ever deletes less. Naming one path in \
483both lists of the *same* file is a typo rather than a decision — the exclusion still \
484wins, so the declaration never runs — and `devp doctor` says so.
485
486Both files are read from the repository root and nowhere else, because the paths inside \
487them are relative to that root. A copy one directory down parses and does nothing at \
488all; `devp doctor` names it rather than moving it, since moving it would change what \
489every path inside it means.";
490
491pub const CONFIG_PROJECT_EXAMPLES: &str = "\
492EXAMPLES:
493  devp config project .           Show (or create) this repository's config
494  devp config project ~/Code/api
495  devp config project . --update  Refresh scaffolding, keep your values
496  devp config project . --team    Create the committed project.devprune.json";
497
498pub const CONFIG_DAEMON_LONG: &str = "\
499The OS background scheduler — Task Scheduler on Windows, launchd on macOS, systemd \
500timers on Linux — which runs `devp run --daemon` every `check_interval_days` days.
501
502Globally: `enable` registers the schedule, `disable` removes it, `status` reports \
503it. With a path first, the same words act on one repository via `disable_daemon` in \
504its `.devprune.json`: the machine-wide pass keeps running, that repository sits it \
505out.";
506
507pub const CONFIG_DAEMON_EXAMPLES: &str = "\
508EXAMPLES:
509  devp daemon status              Machine-wide scheduler state
510  devp daemon enable              Register the schedule (also: install, on)
511  devp daemon disable             Remove it (also: uninstall, remove, off)
512  devp config . daemon disable    This repository opts out of the background pass
513  devp config ~/Code/api daemon enable";
514
515pub const CONFIG_HOOK_LONG: &str = "\
516The global Git hooks (via `core.hooksPath`) that auto-register any repository you \
517commit in — `devp link --quiet`, silent, honouring opt-outs. `enable` installs them, \
518`disable` removes them (restoring what was there), `status` reports them. With a \
519path first, the same words act on one repository via `disable_hooks`.
520
521Git has exactly one global `core.hooksPath` and no way to chain two, so a tool that \
522holds it (husky, pre-commit, lefthook) shuts every other one out. `--chain` is the \
523way through: dev-prune takes the slot and writes, per hook, a shim that does its own \
524work and then execs the same-named hook in the displaced directory — their hooks \
525keep firing, their exit codes still block commits. `devp hook uninstall` puts the \
526original back. The chain snapshots the other tool's hooks at install time; `devp \
527hook status` reports any that have drifted, and `devp hook install --chain` rebuilds.";
528
529pub const CONFIG_HOOK_EXAMPLES: &str = "\
530EXAMPLES:
531  devp hook status                Installed? Chained? Drifted?
532  devp hook install               Take the free core.hooksPath slot
533  devp hook install --chain       Take a slot husky/pre-commit/lefthook holds, forwarding
534  devp hook uninstall             Restore the previous core.hooksPath
535  devp config . hook disable      This repository opts out of auto-registration";
536
537pub const CONFIG_ICON_LONG: &str = "\
538Register `*.devprune.json` with the OS file manager and write the icon files and the \
539JSON Schema into the config directory. On Linux this is a complete registration \
540(shared-mime-info plus hicolor icons — Nautilus, Dolphin, Thunar, Nemo, PCManFM). On \
541Windows, Explorer resolves icons by last extension only, so the config folder gets \
542its own icon instead of hijacking every `.json` on the machine. On macOS a UTI must \
543come from an application bundle, which a single binary is not.
544
545It also prints an editor snippet to paste yourself — it never edits your editor \
546settings, your PATH, or your shell startup files.";
547
548pub const CONFIG_ICON_EXAMPLES: &str = "\
549EXAMPLES:
550  devp icon                       Same command, without the leading `config`";
551
552pub const CONFIG_RECOMMENDED_LONG: &str = "\
553Turn on everything the first run recommends, without sitting through the first run.
554
555The recommendations are the adapters and behaviours that are off by default because \
556they are not universally wanted, not because they are risky: Cargo, Gradle, Maven, \
557Swift, Dart, Mix builds, vcpkg and CMake builds. Accepting them all is one command \
558here and one keypress in `devp config wizard`, and both read the same list, so the \
559two can never drift apart.
560
561One recommendation is held back: `allow_manifest_rewrite` lets `cargo` and `go` tidy \
562up their own manifests during a restore, which edits files in your working tree. \
563That is worth having and it is worth knowing about first, so it arrives only when \
564you type --with-cautious. Everything printed is also printed by `devp config show`, \
565which lists whatever you have not taken yet.
566
567Nothing here is irreversible: `devp config set <key> false` puts any of it back, and \
568this command never marks the settings as reviewed — the walkthrough you skipped is \
569still owed to you, and will still open.";
570
571pub const CONFIG_RECOMMENDED_EXAMPLES: &str = "\
572EXAMPLES:
573  devp config recommended                  Everything recommended without a caveat
574  devp config recommended --with-cautious  That, plus allow_manifest_rewrite
575  devp config show                         What is still outstanding
576  devp config set enable_cargo false       Put one back";
577
578pub const CONFIG_WIZARD_LONG: &str = "\
579Open every global setting in a full-screen configurator, with the `devp trust` \
580declaration in front of it: what this tool is allowed to do is on screen before any \
581of it is configurable.
582
583Enter is the \"keep going\" key: on a row with an untaken recommendation it takes \
584that advice and moves on, on any other row it just moves on, and on the Finish line \
585it opens a summary of exactly what will be written — one more Enter writes it. So \
586holding nothing but Enter reviews every setting, accepts the safe recommendations, \
587and finishes. The walk never takes the cautious tier (`allow_manifest_rewrite`); \
588turning that on stays a deliberate Space on its row. Arrows move without accepting \
589anything; Space changes the highlighted setting — a toggle flips, a number opens a \
590field, `disabled_adapters` opens the adapter checklist; `r` puts one back. `q` \
591leaves without saving anything, from anywhere.
592
593`devp config recommended` is the one-command version of the suggestions screen, for \
594when you know what you want and do not want to walk the list.
595
596It runs itself once on a first install — so the defaults are something you agreed \
597to, not something you inherited — and again after an upgrade adds a setting this \
598machine has never been shown, which it marks NEW and opens on. Settings you have \
599already confirmed are never re-asked.
600
601It never runs unattended: no TTY means skipped, not guessed at. `--no-tui`, and the \
602DEV_PRUNE_NO_TUI environment variable, ask one question per line instead — for \
603terminals the full-screen view cannot drive, and for agents, which hold a real \
604terminal and will never press a key. To configure this tool from a script, use \
605`devp config set <key> <value>`, which needs no terminal at all.";
606
607pub const CONFIG_WIZARD_EXAMPLES: &str = "\
608EXAMPLES:
609  devp config wizard
610  devp config wizard --no-tui              One question per line
611  devp config set disabled_adapters go     Leave Go projects alone entirely
612  devp config set disabled_adapters -      Every adapter active again";
613
614pub const RESTORE_LONG: &str = "\
615Put dependencies back: detect each project's lockfile and run its manager's install \
616(`npm ci`, `pnpm install`, `uv sync`, `cargo fetch`, …). Mirrors pruning — every \
617project in the tree is restored, each by its own manager, so a monorepo comes back \
618whole.
619
620`--last-run` restores exactly what the most recent prune pass deleted, across every \
621repository it touched, and nothing else: the undo for a `devp run`. Each prune \
622records what it removed (a dry run records nothing), and the flag fails cleanly if \
623no pass has been recorded yet. It cannot be combined with a path — silently ignoring \
624the path would restore the wrong thing.";
625
626pub const RESTORE_EXAMPLES: &str = "\
627EXAMPLES:
628  devp restore                    Restore the current directory's projects
629  devp restore ~/Code/my-app
630  devp restore --last-run         Undo the last prune pass, everywhere it acted";
631
632pub const UPDATE_LONG: &str = "\
633Print the installed version, ask GitHub's public API for the latest release, and \
634show the upgrade command for how this copy was installed. `--install` runs the upgrade through the \
635package manager that owns this copy (cargo, npm, bun, pnpm, yarn, uv, pipx, or the \
636installer script). `--channels` prints the command for every channel instead of only \
637this one, and touches nothing. `auto_update` is on by default and does the verified-download half by \
638itself at the end of a prune pass when a newer release is known — never the \
639package-manager half, and nothing at all on WinGet, Scoop and Homebrew, where the \
640manager owns the upgrade; `devp config set auto_update false` stops it. An upgrade never interrupts the \
641scheduler: the scheduled pass runs a managed copy that refreshes itself from the \
642new binary on its next run.
643
644`devp config set version_lock true` outranks all of it. While the pin is on this \
645copy stays on the version it is: `auto_update` does not run however it is set, \
646`--install` refuses, `devp install --channel` refuses because moving channels \
647installs the latest release, and the install scripts leave the binary alone. \
648No flag bypasses it -- `devp config set version_lock false` is the way back.
649
650The same check also runs quietly from `devp run` and `devp status`, at most once \
651every `update_check_interval_days` (7 by default), printing one line only when a \
652newer version exists. It is the only thing in dev-prune that opens a network \
653connection, sends no body and no identifier, and `devp config set update_check \
654false` turns it off for good; `--offline` skips it for one run without changing the \
655setting.";
656
657pub const UPDATE_EXAMPLES: &str = "\
658EXAMPLES:
659  devp update                     Version, latest release, upgrade command
660  devp update --install           Upgrade now, through the owning channel
661  devp update --channels          Every channel's upgrade command, no network
662  devp update --offline           No network this run";
663
664pub const INSTALL_LONG: &str = "\
665Move this installation from one package manager to another.
666
667`devp update` always upgrades the copy that is running, through whichever channel \
668installed it. This command changes *which* channel owns it: it installs through the \
669manager you name, then removes the old copy through the manager that put it there — in \
670that order, so a failed install leaves the working copy untouched.
671
672Removing the old copy through its own manager, rather than deleting the file, is the \
673point: uv, pipx, npm, cargo and the rest each keep a record of what they installed, and \
674a manager whose record still says dev-prune is there will put the old binary back.
675
676bun, pnpm and yarn install the same npm package and are each their own channel, not \
677npm. A copy `bun add -g dev-prune` put in place is upgraded with bun and removed with \
678bun; running npm against it installs a second copy under npm's prefix and leaves the \
679first one stale and still on PATH.
680
681Nothing is migrated, because nothing needs to be. Settings, the repository registry and \
682the undo history live in the config directory, which no package manager owns.
683
684With no `--channel` it prints which manager installed this copy and what `--channel` \
685accepts. `--dry-run` prints the commands without running any of them.";
686
687pub const INSTALL_EXAMPLES: &str = "\
688EXAMPLES:
689  devp install                              Which channel owns this copy
690  devp install --channel winget --dry-run   Print the plan, change nothing
691  devp install --channel uv                 Move onto uv, and remove the old copy
692  devp install --channel cargo --yes        Skip the confirmation prompt";
693
694pub const SKILL_LONG: &str = "\
695Teach your AI assistant this tool. Exports SKILL.md — the full agent-facing manual: \
696every command, the JSON contracts, the safety invariants, the troubleshooting tree — \
697into the config directory, installs it into any detected agent skills directory \
698(`~/.claude/skills/dev-prune/`, the same install `devp setup` performs), and prints \
699ready-to-copy onboarding prompts for assistants without one (Gemini Antigravity, \
700Cursor, Windsurf, Copilot, OpenClaw).
701
702`--agent <EDITOR>` instead writes per-repository rules into the current repository, in \
703the file that editor's agent reads. Ten editors get a file of their own — cursor, \
704windsurf, antigravity, cline, roo, kilocode, continue, amazon-q, kiro, trae — and six \
705share a file with other tools, so dev-prune owns a marked block inside it: agents-md \
706(`AGENTS.md`, the cross-tool convention Codex, Jules, Amp and OpenCode read), copilot \
707(`.github/copilot-instructions.md`), gemini (`GEMINI.md`), junie \
708(`.junie/guidelines.md`), zed (`.rules`) and aider (`CONVENTIONS.md`, the one file its \
709editor does not read by finding it — writing it prints the `read: CONVENTIONS.md` line \
710that makes Aider load it). Every byte outside the markers is left as found. \
711`devp skill --help` lists each value with its exact path. Claude Code needs no \
712per-repository file — its skill installs globally.";
713
714pub const SKILL_EXAMPLES: &str = "\
715EXAMPLES:
716  devp skill                      Export SKILL.md, print onboarding prompts
717  devp skill --agent cursor       Write .cursor/rules/dev-prune.mdc here
718  devp skill --agent agents-md    Upsert the marked block in AGENTS.md";
719
720pub const SETUP_LONG: &str = "\
721Install whatever integration is missing and leave the rest alone: the `devp` alias, \
722the managed binary directory on your PATH (a user PATH entry on Windows, \
723`~/.local/bin` symlinks elsewhere — what keeps `devp` working after the venv or npx \
724cache it came from disappears), the exported SKILL.md and its agent-directory \
725install, the file-manager icon registration, the global Git hooks, and the OS \
726scheduler. Safe to run repeatedly: it is the same pass the install scripts run, the \
727same one `devp init` runs, and the same one that runs by itself on the first command \
728after an upgrade.
729
730It skips rather than forces: Git hooks when `git` is missing or another tool holds \
731`core.hooksPath` (take the slot with `devp hook install --chain`), the alias when \
732the running process is `devp` itself on Windows, and anything switched off by \
733`auto_setup`, `auto_hooks`, `auto_daemon` or `DEV_PRUNE_NO_AUTO_SETUP=1`.
734
735When a VS Code-family editor is on your PATH (VS Code, VSCodium, Cursor, Windsurf, \
736Positron, Kiro, or an Insiders build) and the dev-prune extension is not installed, \
737one run also asks — once ever, only at a terminal — whether to install it into each \
738editor found. Each editor installs from its own registry; when a fork's registry does \
739not carry the extension, the `.vsix` from the extension's own newest release is \
740installed instead. Decline and it never asks again; install it yourself later with \
741`code --install-extension VKrishna04.dev-prune`.";
742
743pub const SETUP_EXAMPLES: &str = "\
744EXAMPLES:
745  devp setup                      Install what is missing, report what was skipped
746  devp setup --status             Report only; change nothing
747  DEV_PRUNE_NO_AUTO_SETUP=1 devp init ~/Code
748                                  Register repositories, install nothing";
749
750pub const DOCTOR_LONG: &str = "\
751One read-only pass that answers \"why is this not doing what I expect\". Without a \
752path it checks the installation: binary and twin, PATH, registry health, every \
753stored setting revalidated, SKILL.md, icons, hooks, scheduler, the package-manager \
754binaries your repositories actually need, and the release-check state. With a path \
755it checks that repository and ends by naming the single reason a prune would or \
756would not touch it.
757
758`--fix` is diagnosis first, then treatment — and it mends installed-but-broken only: \
759a stale or missing `devp` twin, a missing SKILL.md export, hooks or a scheduler \
760whose recorded binary moved, a drifted hook chain, and registry entries whose \
761repository is gone. Each repair is the corresponding `devp setup` pass re-run, so a \
762repair can never do more than setup itself would. It never performs a first-time \
763install, and never touches an unreadable registry — a parse failure is for you to \
764look at, not for a tool to guess at.
765
766EXIT CODES: 0 when everything works, warnings included — a missing scheduler should \
767not fail a script. 1 only for genuine breakage: an unreadable registry, an \
768out-of-range setting, a dead registered path, a directory that is not a Git \
769repository. `--fix` exits 1 when any repair failed or was out of reach.";
770
771pub const DOCTOR_EXAMPLES: &str = "\
772EXAMPLES:
773  devp doctor                     Check the installation
774  devp doctor .                   Why would a prune touch (or skip) this repository?
775  devp doctor ~/Code/api
776  devp doctor --fix               Repair what the installation check finds broken";
777
778pub const UNINSTALL_LONG: &str = "\
779Remove dev-prune from the machine: the OS scheduler, the global Git hooks (only if \
780`core.hooksPath` still points at dev-prune), the file-type icons, the installed \
781agent skill, the PATH entry (or `~/.local/bin` symlinks), and the binaries — the \
782managed pair, the copy you invoked, and, with your confirmation, every other copy \
783found on PATH or in the well-known install directories (`~/.cargo/bin`, \
784`~/.local/bin`, npm's global directory, pip's Scripts directories). A copy owned by \
785a package manager is listed with its manager, and after removal the manager's own \
786uninstall command is printed so its records can be cleared too.
787
788On Windows, where a running executable cannot delete itself, a detached helper \
789removes the last files a few seconds after the command exits — no reboot, no closed \
790terminal.
791
792Without `--deep` the configuration survives, so a reinstall picks up where you left \
793off. With `--deep` the global config folder and every registered repository's \
794`.devprune.json` go too; that asks for confirmation, and refuses outright with no \
795terminal to ask on unless `-y` is passed. Exits 1 if anything could not be removed, \
796naming each leftover.";
797
798pub const UNINSTALL_EXAMPLES: &str = "\
799EXAMPLES:
800  devp uninstall                  Remove the program; keep config for a reinstall
801  devp uninstall --deep           Also wipe config and per-repo .devprune.json (asks)
802  devp uninstall --deep -y        Non-interactive; also confirms the stray-copy sweep";