dev_prune/setup.rs
1// Copyright 2026 VKrishna04
2// SPDX-License-Identifier: Apache-2.0
3
4// Idempotent installation of dev-prune's integrations.
5//
6// dev-prune is only really installed once the parts that let it work without being
7// thought about are in place: the `devp` alias, the managed pair on the user's PATH,
8// the exported `SKILL.md` that AI assistants read (installed into the agent's own
9// skills directory where one exists), the Git hooks that keep the registry current,
10// and the OS scheduler that runs the passes. Each one here is created **only when it
11// is missing**, which is
12// what makes it safe to run on every install, reinstall and upgrade — and it does run
13// on each of those, through the version stamp written at the end of a completed pass.
14//
15// Nothing in here is fatal. A machine without `git`, a `core.hooksPath` that belongs to
16// husky, a locked-down scheduler: each is reported and stepped over, because none of
17// them should stop `devp init` from registering repositories.
18
19use std::fs;
20use std::path::PathBuf;
21
22use anyhow::Result;
23
24use crate::commands::hook::{self, HookState};
25use crate::commands::skill::EMBEDDED_SKILL_MD;
26use crate::config::Registry;
27use crate::constants;
28use crate::daemon;
29use crate::output;
30
31/// File in the config directory recording the version whose last integration pass
32/// completed. A missing or older stamp is what triggers the automatic pass, so a fresh
33/// install and an upgrade both self-heal exactly once.
34const STAMP_FILE: &str = "setup-stamp";
35
36pub use crate::constants::ENV_NO_AUTO_SETUP;
37
38/// Whether the suppression variable is set — by presence, so `=1`, `=true` and even an
39/// empty value all count.
40///
41/// The one predicate every consumer must share. The doctor note used to answer only for
42/// the literal `=1`, so a machine with `=true` had setup switched off with nothing
43/// anywhere saying so.
44pub fn no_auto_setup_requested() -> bool {
45 std::env::var_os(ENV_NO_AUTO_SETUP).is_some()
46}
47
48/// Whether every network call is switched off for this process — same by-presence rule
49/// as [`no_auto_setup_requested`], and for the same reason.
50pub fn offline_requested() -> bool {
51 std::env::var_os(crate::constants::ENV_OFFLINE).is_some()
52}
53
54/// What one integration did during a pass.
55#[derive(Debug, Clone, PartialEq, Eq)]
56pub enum Outcome {
57 /// It was missing and is now in place.
58 Installed,
59 /// It was already in place and was left alone.
60 AlreadyPresent,
61 /// It could not be installed for a reason that is the user's call, not an error.
62 Skipped(String),
63 /// It failed. The pass continues; the reason is reported.
64 Failed(String),
65}
66
67/// The result of one integration pass.
68#[derive(Debug, Default)]
69pub struct SetupReport {
70 items: Vec<(&'static str, Outcome)>,
71}
72
73impl SetupReport {
74 fn push(&mut self, name: &'static str, outcome: Outcome) {
75 self.items.push((name, outcome));
76 }
77
78 /// Whether anything at all was created by this pass.
79 pub fn changed_anything(&self) -> bool {
80 self.items
81 .iter()
82 .any(|(_, o)| matches!(o, Outcome::Installed))
83 }
84
85 /// Whether anything needs the user's attention.
86 pub fn needs_attention(&self) -> bool {
87 self.items
88 .iter()
89 .any(|(_, o)| matches!(o, Outcome::Skipped(_) | Outcome::Failed(_)))
90 }
91
92 /// Print the report.
93 ///
94 /// `verbose` is for the explicit `devp setup`, where "already installed" is the
95 /// answer the user asked for. The automatic pass passes `false` and stays silent
96 /// about everything that was already fine.
97 pub fn print(&self, verbose: bool) {
98 for (name, outcome) in &self.items {
99 match outcome {
100 Outcome::Installed => output::print_success(&format!("{name}: installed.")),
101 Outcome::AlreadyPresent if verbose => {
102 output::print_info(&format!("{name}: already installed."));
103 }
104 Outcome::AlreadyPresent => {}
105 Outcome::Skipped(why) => {
106 output::print_warning(&format!("{name}: skipped — {why}"));
107 }
108 Outcome::Failed(why) => {
109 output::print_error(&format!("{name}: failed — {why}"));
110 }
111 }
112 }
113 }
114}
115
116/// Where the installers put the binary, and the one directory nothing else owns.
117///
118/// Public because it is also what the PATH step registers and what `uninstall` must
119/// take back out again.
120pub fn managed_bin_dir() -> Result<PathBuf> {
121 Ok(Registry::config_dir()?.join("bin"))
122}
123
124pub(crate) fn managed_exe_path() -> Result<PathBuf> {
125 let name = if cfg!(windows) {
126 "dev-prune.exe"
127 } else {
128 "dev-prune"
129 };
130 Ok(managed_bin_dir()?.join(name))
131}
132
133/// Absolute path to a copy of this binary that will still be there next week.
134///
135/// Anything that writes a path down for later — the OS scheduler, the git hooks — has to
136/// use this instead of [`std::env::current_exe`]. dev-prune ships through npm and PyPI as
137/// well as the installers, so the running executable is often somewhere a package manager
138/// owns and will delete: npm's `_npx` cache, uv's ephemeral tool environment, or
139/// `target/debug` during development. An entry recorded there breaks the moment that
140/// directory goes, and neither of these has anywhere to complain — the scheduled task
141/// fails silently every interval, and the hook discards its own output by design. The
142/// only symptom is that nothing ever happens again.
143///
144/// `<config>/bin` is where `install.sh` and `install.ps1` put the binary and nothing else
145/// deletes, so prefer the copy there. When there is none, put one there: the binary that
146/// is running right now is precisely the one that is going to be missing later.
147pub fn stable_exe_path() -> PathBuf {
148 let current = std::env::current_exe().unwrap_or_else(|_| PathBuf::from("dev-prune"));
149 let Ok(managed) = managed_exe_path() else {
150 return current;
151 };
152 if managed == current {
153 return managed;
154 }
155 if managed.is_file() {
156 refresh_managed_copy_if_stale(¤t, &managed);
157 return managed;
158 }
159
160 // Only ever clone something that is actually this CLI. `current_exe()` under `cargo
161 // test` is the test harness, and copying that into the config directory would be both
162 // wrong and slow.
163 if !is_this_cli(¤t) {
164 return current;
165 }
166
167 let Some(parent) = managed.parent() else {
168 return current;
169 };
170 if fs::create_dir_all(parent).is_err() {
171 return current;
172 }
173 // Hard link where the filesystem allows it — that also keeps the bytes alive when the
174 // package manager deletes the directory the original came from.
175 if fs::hard_link(¤t, &managed).is_ok() {
176 return managed;
177 }
178
179 // The same hazard `ensure_alias` documents, through a narrower window: the check at the
180 // top of this function saw no managed copy, but another process created one — as a hard
181 // link to `current` — before the link above ran. `fs::copy` opens its destination with
182 // O_TRUNC, and truncating a hard link empties the shared inode, so the copy would
183 // destroy the very binary it is copying.
184 if managed.is_file() {
185 return managed;
186 }
187
188 // Stage beside and rename into place. A copy straight onto the final name has a
189 // window where the file exists but is incomplete — and this path is what the
190 // scheduler and hooks get registered against, so a process killed mid-copy would
191 // leave a torn binary that every later pass happily points at.
192 let staging = managed.with_extension("new");
193 if fs::copy(¤t, &staging).is_ok() && fs::rename(&staging, &managed).is_ok() {
194 return managed;
195 }
196 let _ = fs::remove_file(&staging);
197 // The rename loses only to a concurrent invocation that installed its own copy,
198 // which serves exactly as well.
199 if managed.is_file() { managed } else { current }
200}
201
202/// Whether this path names one of the CLI's own binaries, by file stem.
203fn is_this_cli(path: &std::path::Path) -> bool {
204 path.file_stem()
205 .and_then(|s| s.to_str())
206 .is_some_and(|stem| stem == "dev-prune" || stem == "devp")
207}
208
209/// Replace the managed copy when it is an older release than the binary running now.
210///
211/// The scheduler and the hooks point at the managed copy precisely because it outlives
212/// package-manager caches — which also means an upgrade through cargo, npm or uv changes
213/// the running binary but not the one the integrations run, and the machine quietly
214/// keeps pruning with the previous version forever.
215///
216/// Staleness is decided by asking the copy its version, not by mtime or content: an
217/// *older* binary running out of a stale npx cache must not overwrite a newer managed
218/// copy, and content inequality cannot say which of the two is the upgrade. A copy that
219/// cannot state a version at all is replaced too — whatever it is, it is not a working
220/// build of this CLI.
221fn refresh_managed_copy_if_stale(current: &std::path::Path, managed: &std::path::Path) {
222 if !is_this_cli(current) || same_contents(managed, current) {
223 return;
224 }
225 match (binary_version(managed), parse_version(constants::VERSION)) {
226 (Some(theirs), Some(ours)) if theirs >= ours => return,
227 _ => {}
228 }
229 // Write beside and rename into place, so a scheduler firing mid-copy never runs a
230 // torn binary. A managed copy that is itself running cannot be renamed over on
231 // Windows; the refresh simply waits for a pass when it is not.
232 let staging = managed.with_extension("new");
233 if fs::copy(current, &staging).is_ok() && fs::rename(&staging, managed).is_ok() {
234 return;
235 }
236 // Unconditionally, because `fs::copy` creates and truncates its destination before it
237 // writes a byte: a copy that fails partway — disk full, the volume going away, a
238 // permission revoked mid-write — leaves a half-written `dev-prune.new` behind. Nothing
239 // else ever removes it. `uninstall`'s sweep knows `*.exe.old`, the debris an update
240 // leaves, and has never known `*.new`, so the file would sit there until someone
241 // noticed it by hand.
242 let _ = fs::remove_file(&staging);
243}
244
245/// The `major.minor.patch` a binary reports for itself, if it can.
246pub(crate) fn binary_version(exe: &std::path::Path) -> Option<(u64, u64, u64)> {
247 let output = crate::spawn::command(exe).arg("--version").output().ok()?;
248 if !output.status.success() {
249 return None;
250 }
251 version_in_output(&String::from_utf8_lossy(&output.stdout))
252}
253
254/// The first `x.y.z` in a `--version` output, with or without the `v` this CLI prints.
255///
256/// Split out so it can be tested against real output. It has to accept `v1.7.0` because
257/// that is the only spelling `print_version_info` produces — the banner ends `v1.7.0`
258/// and the line under it reads `dev-prune (devp) v1.7.0`, and a bare `1.7.0` appears
259/// nowhere. Parsing the tokens without stripping that `v` answered `None` for every real
260/// dev-prune on the machine, and `doctor`'s "Other copies" check reads `None` as "not a
261/// dev-prune at all" — so it reported "none on PATH running a different version" however
262/// many stale copies were sitting there.
263fn version_in_output(text: &str) -> Option<(u64, u64, u64)> {
264 text.split_whitespace()
265 .find_map(|token| parse_version(token.strip_prefix('v').unwrap_or(token)))
266}
267
268/// Parse `x.y.z` into an orderable triple. Anything else — including the pre-release
269/// and build suffixes this project never publishes — answers `None`.
270pub(crate) fn parse_version(text: &str) -> Option<(u64, u64, u64)> {
271 let mut parts = text.split('.');
272 let triple = (
273 parts.next()?.parse().ok()?,
274 parts.next()?.parse().ok()?,
275 parts.next()?.parse().ok()?,
276 );
277 parts.next().is_none().then_some(triple)
278}
279
280/// Keep `dev-prune` and `devp` beside each other, whichever of the two is running.
281///
282/// The pair is one binary under two names, and either one can be the survivor. An upgrade
283/// that could not replace a running `devp` leaves a stale alias; an antivirus quarantine,
284/// a half-finished uninstall or a `Remove-Item` aimed at the wrong name leaves only
285/// `devp`. So this restores *the other* name in whichever direction is missing, rather
286/// than only ever creating `devp` — running either one puts the pair back.
287pub fn ensure_alias() -> Outcome {
288 // WinGet, Scoop and Homebrew each install into a directory they version and replace
289 // whole on upgrade, and each ships both names in the package itself — so there is
290 // nothing to create here, and creating it would be actively wrong twice over. The
291 // twin would be orphaned by the next upgrade, still on PATH, still running the old
292 // release; and writing a second executable beside a freshly downloaded unsigned
293 // binary on its first run is a behavioural malware signature. WinGet's own
294 // post-install validation flags exactly that, which is how this was found.
295 if crate::channel::Channel::detect().replaces_its_directory() {
296 return Outcome::AlreadyPresent;
297 }
298 let Ok(current_exe) = std::env::current_exe() else {
299 return Outcome::Failed("could not locate the running executable".to_string());
300 };
301 let Some(parent_dir) = current_exe.parent() else {
302 return Outcome::Failed("the running executable has no parent directory".to_string());
303 };
304
305 ensure_twin_of(¤t_exe, parent_dir)
306}
307
308/// Whether a twin whose content differs from the running binary is the older of the two,
309/// and so safe to replace.
310///
311/// Content inequality says the pair differ, never which one is the upgrade. `dev-prune` is
312/// *usually* the newer — installers write it first and upgrades replace it first — but
313/// "usually" is not "always", and the direction gate in [`ensure_twin_of`] trusted it
314/// absolutely. An older `dev-prune` restored from a backup, or run out of a
315/// package-manager cache, would delete a newer `devp` and hard-link its own older content
316/// over it: a silent downgrade of the name the documentation tells people to type, reached
317/// through `devp doctor --fix` of all things. So ask the twin its version, exactly as
318/// [`refresh_managed_copy_if_stale`] does, and leave it alone unless it is genuinely
319/// behind. A copy that cannot state a version at all is not a working build of this CLI,
320/// so it is still replaced.
321///
322/// Takes the two versions rather than the two paths so the rule can be tested without a
323/// pair of real binaries that report different versions.
324fn twin_is_stale(theirs: Option<(u64, u64, u64)>, ours: Option<(u64, u64, u64)>) -> bool {
325 !matches!((theirs, ours), (Some(theirs), Some(ours)) if theirs >= ours)
326}
327
328/// The half of [`ensure_alias`] that takes its paths as arguments, so tests can drive both
329/// directions without being the binary they are testing.
330fn ensure_twin_of(current_exe: &std::path::Path, parent_dir: &std::path::Path) -> Outcome {
331 let running_as_alias = current_exe
332 .file_stem()
333 .and_then(|s| s.to_str())
334 .is_some_and(|stem| stem == "devp");
335
336 // `dev-prune` is the canonical name, and only it may overwrite its twin.
337 //
338 // Installers write `dev-prune` first and upgrades replace it first, so a stale `devp`
339 // is worth replacing — otherwise it silently runs the previous version. The reverse is
340 // not safe as a rule: an upgrade that replaced `dev-prune` and then failed on a running
341 // `devp` leaves exactly the state where the alias is the *older* binary, and refreshing
342 // from there would quietly reinstall the version the user just upgraded away from. So
343 // `devp` may only create a `dev-prune` that is missing outright.
344 //
345 // Direction is necessary but not sufficient: see [`twin_is_stale`] for the case where
346 // `dev-prune` itself is the older of the pair.
347 let (twin_name, may_refresh) = if running_as_alias {
348 (
349 if cfg!(windows) {
350 "dev-prune.exe"
351 } else {
352 "dev-prune"
353 },
354 false,
355 )
356 } else {
357 (if cfg!(windows) { "devp.exe" } else { "devp" }, true)
358 };
359 let twin_exe = parent_dir.join(twin_name);
360
361 if twin_exe.exists() {
362 if !may_refresh || same_contents(&twin_exe, current_exe) {
363 return Outcome::AlreadyPresent;
364 }
365 if !twin_is_stale(binary_version(&twin_exe), parse_version(constants::VERSION)) {
366 return Outcome::AlreadyPresent;
367 }
368 // Replacing a running executable fails on Windows; that is fine, the alias is
369 // simply refreshed by the next invocation that is not itself `devp`.
370 if fs::remove_file(&twin_exe).is_err() {
371 return Outcome::Skipped(format!(
372 "`{twin_name}` is in use and could not be refreshed — re-run `devp setup` \
373 from a terminal that is not running it"
374 ));
375 }
376 }
377
378 if fs::hard_link(current_exe, &twin_exe).is_ok() {
379 return Outcome::Installed;
380 }
381
382 // The copy is the fallback for filesystems without hard links — but it must never
383 // run when the alias already exists, because the reason `hard_link` usually fails is
384 // that another process created it a moment ago, as a hard link to this very
385 // executable. `fs::copy` opens its destination with O_TRUNC, and truncating a hard
386 // link truncates the shared inode: the copy would empty the running binary and then
387 // copy zero bytes from it.
388 //
389 // That is not hypothetical. It is what turned every macOS CI run red. The 28
390 // integration tests launch at once, one wins the link, the losers fall through to
391 // here, and `target/debug/dev-prune` becomes a zero-byte file. macOS `posix_spawn`
392 // answers ENOEXEC by handing the file to `/bin/sh`, so every later invocation
393 // "succeeded" with exit 0 and printed nothing — for two hours the tests looked like
394 // 27 unrelated assertion failures.
395 if twin_exe.exists() {
396 return Outcome::AlreadyPresent;
397 }
398
399 // Stage beside and rename into place: copied straight onto the final name, the
400 // alias would exist-but-be-incomplete for the length of the copy, and a `devp`
401 // typed in that window executes a torn binary.
402 let staging = twin_exe.with_extension("new");
403 if fs::copy(current_exe, &staging).is_ok() && fs::rename(&staging, &twin_exe).is_ok() {
404 return Outcome::Installed;
405 }
406 let _ = fs::remove_file(&staging);
407 if twin_exe.exists() {
408 // A concurrent invocation won the rename; its alias serves exactly as well.
409 return Outcome::AlreadyPresent;
410 }
411 Outcome::Failed(format!(
412 "could not create `{}`",
413 output::clean_path(&twin_exe)
414 ))
415}
416
417/// Sameness test for two executables, cheap in the common case.
418///
419/// A hard link makes size and mtime equal by construction, so the usual layout answers
420/// without reading either file. When only the mtime differs — the alias came from the
421/// copy fallback, which does not preserve timestamps — the bytes themselves decide,
422/// because calling that pair "different" made every single invocation delete and
423/// recreate an alias whose content never changed.
424pub(crate) fn same_contents(a: &std::path::Path, b: &std::path::Path) -> bool {
425 let (Ok(ma), Ok(mb)) = (fs::metadata(a), fs::metadata(b)) else {
426 return false;
427 };
428 if ma.len() != mb.len() {
429 return false;
430 }
431 if ma.modified().ok() == mb.modified().ok() {
432 return true;
433 }
434 match (fs::read(a), fs::read(b)) {
435 (Ok(ca), Ok(cb)) => ca == cb,
436 _ => false,
437 }
438}
439
440/// Path that `devp skill` and this module export `SKILL.md` to.
441pub fn skill_path() -> Result<PathBuf> {
442 Ok(Registry::config_dir()?.join("SKILL.md"))
443}
444
445/// Export the bundled `SKILL.md` so AI assistants have something to read.
446///
447/// Rewritten whenever it differs from the embedded copy, since an upgrade that changes
448/// the skill must not leave the previous version's instructions on disk.
449pub fn ensure_skill_file() -> Outcome {
450 match Registry::config_dir() {
451 Ok(dir) => ensure_skill_file_in(&dir),
452 Err(_) => Outcome::Failed("could not determine the config directory".to_string()),
453 }
454}
455
456fn ensure_skill_file_in(config_dir: &std::path::Path) -> Outcome {
457 let target = config_dir.join("SKILL.md");
458
459 if fs::read_to_string(&target).is_ok_and(|current| current == EMBEDDED_SKILL_MD) {
460 return Outcome::AlreadyPresent;
461 }
462
463 let _ = fs::create_dir_all(config_dir);
464 match fs::write(&target, EMBEDDED_SKILL_MD) {
465 Ok(()) => Outcome::Installed,
466 Err(e) => Outcome::Failed(format!(
467 "could not write {}: {e}",
468 output::clean_path(&target)
469 )),
470 }
471}
472
473/// The per-skill directories of AI coding agents that are installed under `home`.
474///
475/// Detection only — an agent's home directory is created by the agent, never by this
476/// pass. Today that is Claude Code, whose Agent Skills live at
477/// `~/.claude/skills/<name>/SKILL.md`. Assistants without an on-disk skill format get
478/// the onboarding prompt from `devp skill` instead.
479fn agent_skill_roots_under(home: &std::path::Path) -> Vec<PathBuf> {
480 let mut roots = Vec::new();
481 let claude = home.join(constants::CLAUDE_HOME_DIR);
482 if claude.is_dir() {
483 roots.push(
484 claude
485 .join(constants::AGENT_SKILLS_SUBDIR)
486 .join(constants::APP_NAME),
487 );
488 }
489 roots
490}
491
492/// The agent skill directories on this machine. Empty when no agent is installed.
493pub fn agent_skill_roots() -> Vec<PathBuf> {
494 dirs::home_dir()
495 .map(|home| agent_skill_roots_under(&home))
496 .unwrap_or_default()
497}
498
499/// Install the skill into every detected agent's skills directory.
500pub fn ensure_agent_skills() -> Outcome {
501 ensure_agent_skills_at(&agent_skill_roots())
502}
503
504/// Every managed copy of `SKILL.md` that is not the one this binary carries.
505///
506/// The copies are refreshed by [`ensure_integrations`], which runs only while
507/// auto-setup is on. With it off, an upgrade leaves the previous release's instructions
508/// sitting in the agent's skills directory, and the agent goes on describing flags that
509/// no longer exist — confidently, because nothing told it otherwise.
510pub fn stale_skill_copies() -> Vec<PathBuf> {
511 let mut copies: Vec<PathBuf> = skill_path().into_iter().collect();
512 copies.extend(agent_skill_roots().into_iter().map(|r| r.join("SKILL.md")));
513 stale_among(copies)
514}
515
516/// The ones of `copies` that exist and differ from the embedded skill.
517///
518/// A path that is not there is not stale — it is a copy this machine never had, and
519/// nothing that refreshes may create it.
520fn stale_among(copies: Vec<PathBuf>) -> Vec<PathBuf> {
521 copies
522 .into_iter()
523 .filter(|p| fs::read_to_string(p).is_ok_and(|current| current != EMBEDDED_SKILL_MD))
524 .collect()
525}
526
527/// Rewrite copies that are already on disk, and only those.
528///
529/// This is the half of [`ensure_skill_copies`] that is safe to run on a machine which
530/// turned auto-setup off: replacing the contents of a file that machine already
531/// consented to is maintenance, not a new integration.
532fn refresh_stale(stale: Vec<PathBuf>) {
533 for path in stale {
534 let _ = fs::write(path, EMBEDDED_SKILL_MD);
535 }
536}
537
538/// Rewrite every managed copy of `SKILL.md` from the embedded one.
539///
540/// Both copies, not just the export: the one an assistant actually reads is the one in
541/// its own skills directory, so repairing the export alone would report success and
542/// leave the stale instructions in the only place that matters.
543pub fn ensure_skill_copies() -> Outcome {
544 let mut installed = false;
545 for outcome in [ensure_skill_file(), ensure_agent_skills()] {
546 match outcome {
547 Outcome::Installed => installed = true,
548 // No agent on this machine is not a failure to repair.
549 Outcome::AlreadyPresent | Outcome::Skipped(_) => {}
550 failed => return failed,
551 }
552 }
553 if installed {
554 Outcome::Installed
555 } else {
556 Outcome::AlreadyPresent
557 }
558}
559
560fn ensure_agent_skills_at(roots: &[PathBuf]) -> Outcome {
561 if roots.is_empty() {
562 return Outcome::Skipped(
563 "no AI agent skills directory was found — `devp skill` prints import prompts instead"
564 .to_string(),
565 );
566 }
567 let mut installed = false;
568 for root in roots {
569 match ensure_skill_file_in(root) {
570 Outcome::Installed => installed = true,
571 Outcome::AlreadyPresent => {}
572 other => return other,
573 }
574 }
575 if installed {
576 Outcome::Installed
577 } else {
578 Outcome::AlreadyPresent
579 }
580}
581
582/// Make the managed pair reachable from a fresh shell.
583///
584/// This is the step that lets `pip install dev-prune` in a virtualenv survive the
585/// virtualenv: the binaries pip placed vanish with the environment, but the managed
586/// copy under `<config>/bin` does not, and after this step it is the one a new
587/// terminal finds. See [`crate::pathenv`] for what "reachable" means per platform.
588pub fn ensure_command_on_path() -> Outcome {
589 let managed = stable_exe_path();
590 let is_managed_copy =
591 managed_exe_path().is_ok_and(|expected| expected == managed) && managed.is_file();
592 if !is_managed_copy {
593 // No managed copy exists and none could be created — under `cargo test` the
594 // running executable is the harness, and cloning that would be wrong. There is
595 // nothing durable to put on PATH.
596 return Outcome::Skipped("no managed copy of the binary exists to put on PATH".to_string());
597 }
598 let Some(bin_dir) = managed.parent() else {
599 return Outcome::Failed("the managed binary has no parent directory".to_string());
600 };
601 // `devp` has to sit beside it, or the PATH entry only ever finds `dev-prune`.
602 if let Outcome::Failed(why) = ensure_twin_of(&managed, bin_dir) {
603 return Outcome::Failed(why);
604 }
605 crate::pathenv::ensure_reachable(bin_dir)
606}
607
608/// Write the icon assets and register `*.devprune.json` with the OS file manager.
609///
610/// Part of the automatic pass rather than a separate errand, because "the config file has
611/// an icon" is not a thing anybody thinks to go and ask for. Everything it writes lives
612/// under the config directory and the user's own XDG data directory, `devp uninstall`
613/// removes all of it, and it touches no editor settings, no PATH and no shell profile —
614/// so there is nothing here that needs to be asked about first.
615///
616/// Unlike the hooks and the scheduler, this has no opt-out switch of its own. Files
617/// dropped into the user's data directory are not a background process and not a change
618/// in behaviour; `auto_setup` already covers "install nothing at all".
619fn ensure_icons() -> Outcome {
620 if crate::commands::icon::is_registered() {
621 return Outcome::AlreadyPresent;
622 }
623 match crate::commands::icon::sync_app_directory() {
624 Ok(()) => Outcome::Installed,
625 Err(e) => Outcome::Failed(format!("{e:#}")),
626 }
627}
628
629/// Install the global Git hooks, unless git is absent or the slot belongs to someone else.
630///
631/// `chain` is `auto_hooks_chain`: with it on, a slot that belongs to husky is not a
632/// reason to skip, because dev-prune can install in front and forward every hook back.
633pub fn ensure_hooks(chain: bool) -> Outcome {
634 if !hook::git_available() {
635 return Outcome::Skipped(format!(
636 "\n {}",
637 hook::GIT_MISSING_HELP.replace('\n', "\n ")
638 ));
639 }
640
641 match hook::state() {
642 // "Installed" is not the question — "installed and pointing at a binary that
643 // still exists" is. A hook backgrounds itself and discards its own output, so
644 // one left pointing at a deleted npm cache dies silently on every commit and
645 // nothing ever registers again; this pass is the only thing that ever looks.
646 // Two reasons to rewrite a working install: it names a binary that is gone, or
647 // it predates the passthrough shims and is silently shadowing every repository's
648 // own `.git/hooks`. Neither reports itself — a hook discards its own output by
649 // design — so the upgrade pass is the only thing that will ever notice.
650 Ok(HookState::Active) if hook_target_is_dead() || hook::shims_incomplete() => {
651 match hook::install() {
652 Ok(()) => Outcome::Installed,
653 Err(e) => Outcome::Failed(format!("{e:#}")),
654 }
655 }
656 Ok(HookState::Active) => Outcome::AlreadyPresent,
657 // Drift is repaired here rather than reported: the setup pass already runs on
658 // install, on update and on a schedule, and a chain the user opted into is a
659 // chain they want kept current.
660 Ok(HookState::Chained { drifted, .. }) if !drifted.is_empty() => {
661 match hook::install_with(true) {
662 Ok(()) => Outcome::Installed,
663 Err(e) => Outcome::Failed(format!("{e:#}")),
664 }
665 }
666 Ok(HookState::Chained { .. }) if hook_target_is_dead() => match hook::install_with(true) {
667 Ok(()) => Outcome::Installed,
668 Err(e) => Outcome::Failed(format!("{e:#}")),
669 },
670 Ok(HookState::Chained { .. }) => Outcome::AlreadyPresent,
671 Ok(HookState::Foreign(_)) if chain => match hook::install_with(true) {
672 Ok(()) => Outcome::Installed,
673 Err(e) => Outcome::Failed(format!("{e:#}")),
674 },
675 Ok(HookState::Foreign(existing)) => Outcome::Skipped(format!(
676 "`core.hooksPath` is already set to `{existing}`, which belongs to another tool.\n \
677 Git allows only one hooks directory, so dev-prune will not take the slot.\n \
678 `devp hook install --chain` installs in front of it instead — dev-prune registers \
679 the repo, then hands every hook on to `{existing}`, and `devp hook uninstall` puts \
680 the original setting back (`devp config set auto_hooks_chain true` makes that \
681 the standing answer). Or skip it: `devp link .` does the same job by hand."
682 )),
683 Ok(HookState::Absent) => match hook::install() {
684 Ok(()) => Outcome::Installed,
685 Err(e) => Outcome::Failed(format!("{e:#}")),
686 },
687 Err(e) => Outcome::Failed(format!("{e:#}")),
688 }
689}
690
691/// Whether the installed hooks name a binary that no longer exists.
692fn hook_target_is_dead() -> bool {
693 hook::registered_exe_path().is_some_and(|exe| !exe.exists())
694}
695
696/// Install the OS scheduler if it is not already registered.
697pub fn ensure_daemon(interval_days: u64) -> Outcome {
698 match daemon::daemon_status() {
699 // A task whose binary has been deleted keeps reporting itself `Ready` and dies
700 // the instant it fires, every interval, with nowhere to complain. Re-register
701 // it against the stable path instead of counting the corpse as present.
702 Ok(daemon::DaemonStatus::Installed)
703 if daemon::registered_exe_path().is_some_and(|exe| !exe.exists()) =>
704 {
705 match daemon::install_daemon(interval_days) {
706 Ok(()) => Outcome::Installed,
707 Err(e) => Outcome::Failed(format!("{e:#}")),
708 }
709 }
710 // A task registered by a version that only knew the interactive logon flashes a
711 // console window at whoever is logged in every time it fires — the single most
712 // trust-destroying thing a background tool can do. Re-register it windowless;
713 // a machine whose scheduler refuses the sessionless logon remembers the refusal
714 // and is not asked again.
715 Ok(daemon::DaemonStatus::Installed) if daemon::wants_windowless_upgrade() => {
716 match daemon::install_daemon(interval_days) {
717 Ok(()) => Outcome::Installed,
718 Err(e) => Outcome::Failed(format!("{e:#}")),
719 }
720 }
721 // A settled task still needs its windowless twin kept current: the twin
722 // is a copy of the binary, so an upgrade that replaced the binary would otherwise
723 // leave the daemon firing the previous release. No-op on the other platforms, and
724 // when no twin is in use.
725 Ok(daemon::DaemonStatus::Installed) => {
726 daemon::refresh_windowless_twin();
727 Outcome::AlreadyPresent
728 }
729 Ok(daemon::DaemonStatus::NotInstalled) => match daemon::install_daemon(interval_days) {
730 Ok(()) => Outcome::Installed,
731 Err(e) => Outcome::Failed(format!("{e:#}")),
732 },
733 // `Unknown` means the query itself could not be answered — the scheduler may
734 // well be there. Installing over it would fail on every command from now on, so
735 // this reports and steps over instead of guessing. The platform backends are
736 // written to keep this case narrow: anything they can answer definitely, they do.
737 Ok(daemon::DaemonStatus::Unknown(why)) => {
738 Outcome::Skipped(format!("scheduler state could not be read — {why}"))
739 }
740 Err(e) => Outcome::Failed(format!("{e:#}")),
741 }
742}
743
744/// Whether unattended installation is permitted at all.
745///
746/// Both switches exist because these integrations write outside dev-prune's own config
747/// directory — a scheduled task, a global git setting — and there are places that must
748/// never happen unasked: container images, CI, and this project's own test suite.
749pub fn auto_setup_enabled(registry: &Registry) -> bool {
750 !no_auto_setup_requested() && registry.settings.auto_setup && unattended_environment().is_none()
751}
752
753/// The reason this looks like a machine nobody is sitting at, if it does.
754///
755/// `DEV_PRUNE_NO_AUTO_SETUP` and `auto_setup` are both switches you have to set *before*
756/// the first run — which is exactly the run that installs things, so in a container or a
757/// CI job the damage is done by the time there is anywhere to set them. Detecting the
758/// environment is the only opt-out that works on the first run, which is the only run
759/// that matters here.
760///
761/// Deliberately conservative: every signal below is one that CI providers and container
762/// runtimes set themselves, so a developer's own shell will not trip it. Someone who
763/// genuinely wants the integrations in CI can still ask in so many words with
764/// `devp setup`, which never consults this.
765pub fn unattended_environment() -> Option<&'static str> {
766 // Set by GitHub Actions, GitLab CI, CircleCI, Travis, Jenkins (via pipeline), Woodpecker
767 // and most others. `CI=true` is the closest thing this space has to a standard.
768 for var in [
769 "CI",
770 "CONTINUOUS_INTEGRATION",
771 "BUILD_NUMBER",
772 "GITHUB_ACTIONS",
773 ] {
774 if let Some(value) = std::env::var_os(var) {
775 // `CI=false` is set explicitly by some tools to mean "not CI", and honouring
776 // the word rather than the presence is what the user plainly meant.
777 let value = value.to_string_lossy();
778 if !value.is_empty() && !value.eq_ignore_ascii_case("false") {
779 return Some("this looks like a CI runner");
780 }
781 }
782 }
783
784 // Docker writes this marker into every container it builds from a Dockerfile;
785 // Podman and other OCI runtimes write the `container` variable instead.
786 #[cfg(unix)]
787 if std::path::Path::new("/.dockerenv").exists() {
788 return Some("this looks like a container");
789 }
790 if std::env::var_os("container").is_some() {
791 return Some("this looks like a container");
792 }
793
794 None
795}
796
797/// Whether this integration pass was asked for by name.
798///
799/// The only thing it decides is the `devp` twin. Writing a second executable beside the
800/// first is a self-installation, and doing it *unasked*, on the first run of a freshly
801/// downloaded unsigned binary, alongside registering a scheduled task, is a behavioural
802/// malware signature — it is what earned this package a `Validation-Defender-Error` on
803/// microsoft/winget-pkgs#422665. Asked for in so many words, the same write is an
804/// ordinary install step. Nothing else in the pass changes.
805#[derive(Clone, Copy, PartialEq, Eq)]
806pub enum Consent {
807 /// `devp setup`, or `devp doctor --fix`.
808 Explicit,
809 /// The pass that runs on its own when `auto_setup` is on.
810 Unattended,
811}
812
813/// Run an integration pass unless unattended installation is switched off.
814///
815/// Every caller that the user did not name explicitly goes through this. `devp setup`
816/// calls [`ensure_integrations`] with [`Consent::Explicit`]: asking for it in so many
817/// words is consent.
818pub fn ensure_integrations_if_enabled(registry: &Registry) -> Option<SetupReport> {
819 auto_setup_enabled(registry).then(|| ensure_integrations(registry, Consent::Unattended))
820}
821
822/// Run one integration pass, installing whatever is missing.
823///
824/// The two per-integration settings (`auto_daemon`, `auto_hooks`) are honoured here, so
825/// turning one off turns it off for every future pass as well as this one.
826pub fn ensure_integrations(registry: &Registry, consent: Consent) -> SetupReport {
827 let mut report = SetupReport::default();
828
829 // Only when asked. This is the twin *beside the running binary*, which on an
830 // unattended pass means beside whatever the delivery vehicle happened to be: npm's
831 // cache, a venv's `Scripts`, a Downloads folder. Every channel already ships both
832 // names as real files — the archives, the npm and PyPI packages, and two `[[bin]]`
833 // targets for `cargo install` — so there is normally nothing to create, and the one
834 // case left over is a manual install that skipped `dev-prune setup`, which `devp
835 // doctor` reports with a one-command fix.
836 //
837 // The pair that actually matters is not this one. `ensure_command_on_path` below
838 // keeps `dev-prune` and `devp` together in the managed `bin` directory, which is
839 // the directory on the user's PATH and the one `devp uninstall` knows about, and it
840 // runs on every pass.
841 if consent == Consent::Explicit {
842 report.push("dev-prune/devp pair", ensure_alias());
843 }
844 report.push("Command on PATH", ensure_command_on_path());
845 report.push("SKILL.md", ensure_skill_file());
846 // Only reported when an agent is actually installed: a machine without one would
847 // otherwise see a "skipped" warning about software it never had, on every install.
848 if !agent_skill_roots().is_empty() {
849 report.push("AI agent skills", ensure_agent_skills());
850 }
851 report.push("File icons", ensure_icons());
852
853 if registry.settings.auto_hooks {
854 report.push(
855 "Git hooks",
856 ensure_hooks(registry.settings.auto_hooks_chain),
857 );
858 } else {
859 report.push(
860 "Git hooks",
861 Outcome::Skipped("`auto_hooks` is false — enable with `devp hook install`".to_string()),
862 );
863 }
864
865 if registry.settings.auto_daemon {
866 report.push(
867 "Background scheduler",
868 ensure_daemon(registry.settings.check_interval_days),
869 );
870 } else {
871 report.push(
872 "Background scheduler",
873 Outcome::Skipped(
874 "`auto_daemon` is false — enable with `devp daemon install`".to_string(),
875 ),
876 );
877 }
878
879 report
880}
881
882// ── VS Code extension ────────────────────────────────────────────────────────
883
884/// Marker recording that the extension question was asked (or found already answered by
885/// an existing install). One file, no content: the offer is made once ever, whatever
886/// the answer was — a declined install must not be re-litigated on every upgrade.
887const VSCODE_OFFER_STAMP: &str = "vscode-ext-offered";
888
889/// A VS Code-compatible editor found on PATH.
890struct EditorCli {
891 /// The command to invoke — on Windows the `.cmd` launcher, because the entry on
892 /// PATH is a batch file, not an `.exe`, and `Command::new("code")` would miss it.
893 cli: String,
894 /// The editor's name as a person knows it, for the prompt and per-editor results.
895 label: &'static str,
896}
897
898/// Every VS Code-compatible editor on PATH, in the order listed here.
899///
900/// All of these forks keep the upstream CLI protocol (`--version`, `--list-extensions`,
901/// `--install-extension`), so one code path drives them all. What differs is the
902/// registry each one resolves an extension ID against: VS Code uses the Microsoft
903/// Marketplace, VSCodium/Windsurf/Positron/Kiro/Trae use OpenVSX, Cursor and
904/// Antigravity run their own mirrors. An ID install can therefore fail on a fork whose
905/// registry does not carry the extension yet — which is why the installer falls back
906/// to the `.vsix` from the GitHub release, the artifact every registry copy is built
907/// from.
908///
909/// The list is candidate CLI names, not a claim that any of them is installed: each is
910/// asked for its `--version` and dropped if it does not answer. Adding a fork therefore
911/// costs one failed spawn on a machine without it, and is what stops the extension
912/// offer from being a VS Code-only courtesy on an editor that is a VS Code build with a
913/// different name on the window.
914fn detect_vscode_editors() -> Vec<EditorCli> {
915 const CANDIDATES: &[(&str, &str)] = &[
916 ("code", "VS Code"),
917 ("code-insiders", "VS Code Insiders"),
918 ("codium", "VSCodium"),
919 ("codium-insiders", "VSCodium Insiders"),
920 ("cursor", "Cursor"),
921 ("windsurf", "Windsurf"),
922 ("antigravity", "Antigravity"),
923 ("trae", "Trae"),
924 ("positron", "Positron"),
925 ("kiro", "Kiro"),
926 ];
927 CANDIDATES
928 .iter()
929 .filter_map(|(name, label)| {
930 let cli = if cfg!(windows) {
931 format!("{name}.cmd")
932 } else {
933 (*name).to_string()
934 };
935 let responds = crate::spawn::command(&cli)
936 .arg("--version")
937 .stdin(std::process::Stdio::null())
938 .stdout(std::process::Stdio::null())
939 .stderr(std::process::Stdio::null())
940 .status()
941 .map(|s| s.success())
942 .unwrap_or(false);
943 responds.then_some(EditorCli { cli, label })
944 })
945 .collect()
946}
947
948fn vscode_extension_installed(cli: &str) -> bool {
949 crate::spawn::command(cli)
950 .arg("--list-extensions")
951 .stdin(std::process::Stdio::null())
952 .output()
953 .map(|out| {
954 String::from_utf8_lossy(&out.stdout).lines().any(|line| {
955 line.trim()
956 .eq_ignore_ascii_case(constants::VSCODE_EXTENSION_ID)
957 })
958 })
959 .unwrap_or(false)
960}
961
962/// Download the `.vsix` from the newest extension release into the config directory.
963///
964/// The release asset is the source of truth for the extension — the Marketplace and
965/// OpenVSX listings are published from that exact file — so when an editor's registry
966/// cannot resolve the ID (a fork whose registry does not carry the extension),
967/// installing the release file directly gets the same bits through a channel every fork
968/// supports. Editors update a `.vsix`-installed extension from their registry once a
969/// newer listed version appears, so this install self-heals into the normal update flow.
970///
971/// Deliberately not `releases/latest`. The extension has its own tags and its own
972/// release page, and those releases are marked "not latest" so they cannot displace the
973/// binary release that `devp update` reads. The consequence is that the newest one has
974/// to be found by walking the listing for a [`VSCODE_RELEASE_TAG_PREFIX`] tag.
975///
976/// [`VSCODE_RELEASE_TAG_PREFIX`]: crate::constants::VSCODE_RELEASE_TAG_PREFIX
977fn download_release_vsix() -> Option<std::path::PathBuf> {
978 use std::time::Duration;
979
980 if offline_requested() {
981 return None;
982 }
983
984 let fetch = |url: &str| {
985 ureq::get(url)
986 .header("User-Agent", &format!("dev-prune/{}", constants::VERSION))
987 .header("Accept", "application/vnd.github+json")
988 .config()
989 .timeout_global(Some(Duration::from_secs(30)))
990 .build()
991 .call()
992 };
993
994 let body = fetch(constants::RELEASES_LIST_API_URL)
995 .ok()?
996 .body_mut()
997 .read_to_string()
998 .ok()?;
999 let json: serde_json::Value = serde_json::from_str(&body).ok()?;
1000 // GitHub returns this listing newest-first, so the first extension release found is
1001 // the current one. Draft releases carry no downloadable asset, and a pre-release of
1002 // the extension is one deliberately not being offered to people who did not ask.
1003 let asset = json.as_array()?.iter().find_map(|release| {
1004 let tag = release.get("tag_name")?.as_str()?;
1005 if !tag.starts_with(constants::VSCODE_RELEASE_TAG_PREFIX) {
1006 return None;
1007 }
1008 if release.get("draft")?.as_bool()? || release.get("prerelease")?.as_bool()? {
1009 return None;
1010 }
1011 release.get("assets")?.as_array()?.iter().find_map(|asset| {
1012 let name = asset.get("name")?.as_str()?;
1013 if !name.ends_with(".vsix") {
1014 return None;
1015 }
1016 let url = asset.get("browser_download_url")?.as_str()?;
1017 Some((name.to_string(), url.to_string()))
1018 })
1019 })?;
1020
1021 let bytes = fetch(&asset.1).ok()?.body_mut().read_to_vec().ok()?;
1022 // The config directory, not the shared system temp dir: on a multi-user machine
1023 // `%TEMP%`-style paths are predictable and writable by others, and the editor is
1024 // about to execute what this file contains. The caller deletes it after installing.
1025 let dir = Registry::config_dir().ok()?;
1026 fs::create_dir_all(&dir).ok()?;
1027 let path = dir.join(&asset.0);
1028 fs::write(&path, bytes).ok()?;
1029 Some(path)
1030}
1031
1032/// `<cli> --install-extension <arg>`, surfacing the editor's own output.
1033fn run_install(cli: &str, arg: &str) -> bool {
1034 crate::spawn::command(cli)
1035 .args(["--install-extension", arg])
1036 .stdin(std::process::Stdio::null())
1037 .status()
1038 .map(|s| s.success())
1039 .unwrap_or(false)
1040}
1041
1042/// Offer to install the editor extension, once ever, when a VS Code-family editor is
1043/// present.
1044///
1045/// This asks rather than installs because the editor is not dev-prune's territory the
1046/// way its own config directory is. Every gate below is a way of making sure a person
1047/// is actually there to answer: no marker yet, not a CI runner or container, both ends
1048/// of the terminal attached. When no editor is found nothing is written, so installing
1049/// one later and re-running `devp setup` still gets the one offer.
1050pub fn offer_vscode_extension() {
1051 use std::io::{IsTerminal, Write};
1052
1053 let Ok(config_dir) = Registry::config_dir() else {
1054 return;
1055 };
1056 if config_dir.join(VSCODE_OFFER_STAMP).exists() {
1057 return;
1058 }
1059 if no_auto_setup_requested()
1060 || unattended_environment().is_some()
1061 || !std::io::stdin().is_terminal()
1062 || !std::io::stdout().is_terminal()
1063 {
1064 return;
1065 }
1066 let editors = detect_vscode_editors();
1067 if editors.is_empty() {
1068 return;
1069 }
1070
1071 let write_marker = || {
1072 let _ = fs::create_dir_all(&config_dir);
1073 let _ = fs::write(config_dir.join(VSCODE_OFFER_STAMP), "");
1074 };
1075
1076 let missing: Vec<&EditorCli> = editors
1077 .iter()
1078 .filter(|e| !vscode_extension_installed(&e.cli))
1079 .collect();
1080 if missing.is_empty() {
1081 write_marker();
1082 return;
1083 }
1084
1085 let names = missing
1086 .iter()
1087 .map(|e| e.label)
1088 .collect::<Vec<_>>()
1089 .join(", ");
1090 println!();
1091 println!("{names} detected — install the dev-prune extension?");
1092 println!(" It validates .devprune.json and shows reclaimable space in the status bar.");
1093 // The listings and the source, before the question rather than after it. This is
1094 // the one prompt that defaults to yes, so the material someone would need in order
1095 // to say no has to be on screen at the moment they answer — not in a doc they would
1096 // have to go and look for.
1097 println!(" Marketplace: {}", constants::VSCODE_MARKETPLACE_URL);
1098 println!(" Open VSX: {}", constants::OPENVSX_URL);
1099 println!(" Source: {}", constants::REPO_URL);
1100 print!(" Install it? [Y/n] ");
1101 let _ = std::io::stdout().flush();
1102 let mut answer = String::new();
1103 if std::io::stdin().read_line(&mut answer).is_err() {
1104 return;
1105 }
1106 write_marker();
1107
1108 // A bare Enter accepts. Unlike the uninstall sweep — which deletes — the worst case
1109 // here is an extension the person removes in two clicks, and the gates above have
1110 // already established that a human with a VS Code-family editor is watching.
1111 if !matches!(answer.trim().to_lowercase().as_str(), "" | "y" | "yes") {
1112 output::print_info(&format!(
1113 "Skipped. Install it any time with `{} --install-extension {}`, or from {}.",
1114 missing[0].cli,
1115 constants::VSCODE_EXTENSION_ID,
1116 constants::VSCODE_MARKETPLACE_URL
1117 ));
1118 return;
1119 }
1120
1121 // Fetched at most once, shared by every editor whose registry install fails.
1122 let mut release_vsix: Option<Option<std::path::PathBuf>> = None;
1123 for editor in &missing {
1124 // The editor's own registry first: that install is the one the editor keeps
1125 // up to date by itself.
1126 if run_install(&editor.cli, constants::VSCODE_EXTENSION_ID) {
1127 output::print_success(&format!("{}: extension installed.", editor.label));
1128 continue;
1129 }
1130 // A fork whose registry does not carry the extension — install the `.vsix`
1131 // from the GitHub release instead.
1132 let vsix = release_vsix.get_or_insert_with(download_release_vsix);
1133 match vsix {
1134 Some(path) if run_install(&editor.cli, &path.to_string_lossy()) => {
1135 output::print_success(&format!(
1136 "{}: extension installed from the GitHub release .vsix.",
1137 editor.label
1138 ));
1139 }
1140 _ => {
1141 output::print_warning(&format!(
1142 "{}: could not install it from here. Search the Extensions view for \"dev-prune\", or run `{} --install-extension {}` yourself.",
1143 editor.label,
1144 editor.cli,
1145 constants::VSCODE_EXTENSION_ID
1146 ));
1147 }
1148 }
1149 }
1150 if let Some(Some(path)) = &release_vsix {
1151 let _ = fs::remove_file(path);
1152 }
1153}
1154
1155/// Record that a pass completed for this version.
1156fn write_stamp_in(config_dir: &std::path::Path) {
1157 let _ = fs::create_dir_all(config_dir);
1158 let _ = fs::write(config_dir.join(STAMP_FILE), constants::VERSION);
1159}
1160
1161fn write_stamp() {
1162 if let Ok(dir) = Registry::config_dir() {
1163 write_stamp_in(&dir);
1164 }
1165}
1166
1167fn setup_is_due_in(config_dir: &std::path::Path) -> bool {
1168 !fs::read_to_string(config_dir.join(STAMP_FILE))
1169 .is_ok_and(|stamp| stamp.trim() == constants::VERSION)
1170}
1171
1172/// Whether the unattended pass is due: a fresh install, or the first run after an upgrade.
1173pub fn setup_is_due() -> bool {
1174 Registry::config_dir()
1175 .map(|dir| setup_is_due_in(&dir))
1176 .unwrap_or(false)
1177}
1178
1179/// Whether there is a human at this invocation who could see what was done and undo it.
1180///
1181/// The one question that gates everything dev-prune installs without being asked. CI
1182/// variables and containers answer it directly; a redirected stdin or stdout answers it
1183/// too, because output nobody reads is the same as no output — and an integration
1184/// installed silently is one nobody knows to remove.
1185fn a_person_is_present() -> bool {
1186 use std::io::IsTerminal;
1187 unattended_environment().is_none()
1188 && std::io::stdin().is_terminal()
1189 && std::io::stdout().is_terminal()
1190}
1191
1192/// The unattended pass, run at most once per installed version.
1193///
1194/// Called at the top of every command that a human typed. It is deliberately not called
1195/// for the Git hook's `link --quiet` or the scheduler's `run --daemon`: those run without
1196/// a terminal, and an integration pass that nobody can see is one nobody can refuse.
1197pub fn auto_setup_if_due() {
1198 if !setup_is_due() {
1199 first_run_config_review();
1200 return;
1201 }
1202 // The same question `first_run_config_review` asks, asked one step earlier. It used
1203 // to be asked only about the *prompt*, never about the pass that installs a PATH
1204 // entry, a scheduled task and a git hook — so a binary run once by an automated
1205 // system, with its output captured, silently acquired persistence on that machine.
1206 // Nothing here is skipped permanently: the stamp is not written, so the first run a
1207 // person can actually see does the pass and reports it.
1208 if !a_person_is_present() {
1209 return;
1210 }
1211
1212 review_project_venv_install();
1213
1214 let Ok(registry) = Registry::load() else {
1215 return;
1216 };
1217 let Some(report) = ensure_integrations_if_enabled(®istry) else {
1218 // Suppressed. Stamp anyway, so a machine that opted out does not re-decide
1219 // this on every single command.
1220 //
1221 // The one thing opting out must not do is freeze the instructions AI agents
1222 // read at whichever version installed them. The stamp below is what would
1223 // freeze them: it is rewritten for every new version without a pass ever
1224 // running, so an existing `SKILL.md` here would never be reconsidered again,
1225 // and the agent would go on describing flags that were removed two releases
1226 // ago — confidently, because nothing told it otherwise.
1227 refresh_stale(stale_skill_copies());
1228 write_stamp();
1229 crate::commands::config::skip_config_review();
1230 return;
1231 };
1232 if report.changed_anything() || report.needs_attention() {
1233 output::print_header("dev-prune setup");
1234 report.print(false);
1235 if report.changed_anything() {
1236 output::print_info(
1237 "Run `devp setup --status` to review these, or `devp uninstall` to remove them.",
1238 );
1239 }
1240 println!();
1241 }
1242 write_stamp();
1243 first_run_config_review();
1244}
1245
1246/// Put the defaults in front of the user on a fresh install, and any setting an upgrade
1247/// added that they have never been shown.
1248///
1249/// Separate from the integration stamp on purpose. The integrations are re-checked after
1250/// every upgrade; the settings are not, except for the ones that did not exist last time
1251/// — being asked to reconfirm `idle_days` on each new version would be a nuisance, and a
1252/// nuisance is something people learn to dismiss without reading.
1253///
1254/// Every condition here is a way of asking "is there a person reading this?", because the
1255/// alternative to asking is a prompt written into a log nobody will read, on a run that
1256/// then blocks forever waiting for an answer.
1257fn first_run_config_review() {
1258 if !crate::commands::config::config_review_is_due() {
1259 return;
1260 }
1261
1262 // Deliberately not stamped here. The stamp records that somebody was *shown* the
1263 // declaration, and a cron run, a CI job or a container has nobody to show it to.
1264 // Writing it anyway meant the first unattended `devp` on a machine silently spent
1265 // the one screen that says what dev-prune will not delete — so the person who
1266 // installed it never saw it, and nothing ever offered again. Left unstamped, the
1267 // walkthrough waits for the first run with a human on the other end of it, which is
1268 // the only run it was ever for.
1269 if !a_person_is_present() {
1270 return;
1271 }
1272
1273 // Any error here is the wizard's own reporting; the command the user actually typed
1274 // still runs. A failed walkthrough must not become a failed `devp status`.
1275 if let Err(e) =
1276 crate::commands::config::run_wizard(false, crate::commands::config::Opened::OnItsOwn)
1277 {
1278 output::print_warning(&format!("Could not run the first-run setup ({e:#})."));
1279 }
1280 // Marked regardless of how it ended, including a deliberate quit. This is the one
1281 // caller that runs uninvited, and an unasked-for walkthrough that reappears on every
1282 // subsequent command is worse than one somebody dismissed once on purpose.
1283 crate::commands::config::skip_config_review();
1284 // Same first run, same person already answering questions — the one moment the
1285 // extension offer is a courtesy rather than an interruption.
1286 offer_vscode_extension();
1287 println!();
1288}
1289
1290/// Invalidate the stamp so the next human-run command performs a pass.
1291///
1292/// `uninstall` calls this in reverse — it writes the current stamp — so that removing the
1293/// integrations is not immediately undone by the next command.
1294pub fn suppress_next_auto_setup() {
1295 write_stamp();
1296}
1297
1298/// Say something, once, when this copy is running from inside a project's virtualenv.
1299///
1300/// This is the remedy at the source. By the time a prune pass refuses the environment,
1301/// the user is several days and one confusing error away from the moment they typed
1302/// `pip install dev-prune` with a project activated; saying it here, on the first run
1303/// after that install, is the only chance to explain it while the cause is still in
1304/// living memory. The refusal in the venv adapter stays as the failsafe, for a copy
1305/// installed before this check existed or by somebody who dismissed it.
1306///
1307/// Silent when `requirements.txt` already lists the tool. That is somebody who meant it,
1308/// and being told about a decision you made on purpose is what teaches people to stop
1309/// reading output.
1310fn review_project_venv_install() {
1311 let Ok(exe) = std::env::current_exe() else {
1312 return;
1313 };
1314 let Some(found) = crate::channel::project_venv_install(&exe) else {
1315 return;
1316 };
1317
1318 let requirements = found.project.join("requirements.txt");
1319 let recorded = crate::adapters::venv::requirement_names(&requirements, &mut Vec::new())
1320 .is_some_and(|names| names.iter().any(|n| crate::adapters::venv::is_dev_prune(n)));
1321 if recorded {
1322 return;
1323 }
1324
1325 output::print_header(&format!(
1326 "{} is installed inside this project's virtual environment",
1327 constants::APP_NAME
1328 ));
1329 println!(" running from {}", exe.display());
1330 println!(" environment {}", found.venv.display());
1331 println!(" project {}", found.project.display());
1332 println!();
1333 output::print_info(
1334 "A tool install belongs outside a project: it outlives the environment, every \
1335 repository shares it, and it never has to appear in an application's \
1336 requirements file to stay out of the way.",
1337 );
1338
1339 if requirements.is_file() {
1340 println!();
1341 output::print_info(
1342 "Until that is fixed, a prune pass will decline this project's environment \
1343 — a package `requirements.txt` does not account for is a package nothing \
1344 can rebuild.",
1345 );
1346 println!();
1347 if record_in_requirements(&requirements) {
1348 return;
1349 }
1350 }
1351
1352 println!();
1353 println!(" Remove this copy and install it as a tool instead:");
1354 println!(" pip uninstall {}", constants::APP_NAME);
1355 println!(" uv tool install {}", constants::APP_NAME);
1356 println!(" # or: pipx install {}", constants::APP_NAME);
1357 report_other_copy(&exe);
1358 println!();
1359}
1360
1361/// Offer the other repair: declare the tool a dependency of this project, on purpose.
1362///
1363/// Default no, for the reason `devp restore` defaults no on a substituted interpreter —
1364/// this is the branch that writes into a file in somebody's repository, so a reflexive
1365/// Enter must not be what agrees to it. Returns whether the file was written, which is
1366/// also whether the removal instructions are still worth printing.
1367fn record_in_requirements(requirements: &std::path::Path) -> bool {
1368 use std::io::{IsTerminal, Write};
1369 if !std::io::stdin().is_terminal() {
1370 return false;
1371 }
1372 eprint!(
1373 "Record {} in requirements.txt instead, as a deliberate dev dependency? [y/N]: ",
1374 constants::APP_NAME
1375 );
1376 if std::io::stderr().flush().is_err() {
1377 return false;
1378 }
1379 let mut input = String::new();
1380 if std::io::stdin().read_line(&mut input).is_err() {
1381 return false;
1382 }
1383 if !matches!(input.trim().to_lowercase().as_str(), "y" | "yes") {
1384 return false;
1385 }
1386
1387 let Ok(existing) = fs::read_to_string(requirements) else {
1388 output::print_warning("Could not read requirements.txt, so nothing was changed.");
1389 return false;
1390 };
1391 // Requirements files without a trailing newline are common, and appending to one
1392 // blind would glue the pin onto the last requirement.
1393 let separator = if existing.is_empty() || existing.ends_with('\n') {
1394 ""
1395 } else {
1396 "\n"
1397 };
1398 let line = format!(
1399 "{separator}{}=={}\n",
1400 constants::APP_NAME,
1401 constants::VERSION
1402 );
1403 match std::fs::OpenOptions::new()
1404 .append(true)
1405 .open(requirements)
1406 .and_then(|mut f| f.write_all(line.as_bytes()))
1407 {
1408 Ok(()) => {
1409 output::print_success(&format!(
1410 "Added `{}=={}` to {}. The environment is prunable now.",
1411 constants::APP_NAME,
1412 constants::VERSION,
1413 requirements.display()
1414 ));
1415 true
1416 }
1417 Err(e) => {
1418 output::print_warning(&format!("Could not write requirements.txt ({e})."));
1419 false
1420 }
1421 }
1422}
1423
1424/// Name the copy that is already installed properly, if there is one.
1425///
1426/// "Uninstall this" reads very differently depending on whether it leaves the user with
1427/// no tool at all or with the one they already had — and on a machine where this mistake
1428/// happens there usually is one, because the working copy is what they were reaching for
1429/// in the first place.
1430fn report_other_copy(exe: &std::path::Path) {
1431 let names: [&str; 2] = if cfg!(windows) {
1432 ["dev-prune.exe", "devp.exe"]
1433 } else {
1434 ["dev-prune", "devp"]
1435 };
1436 let home = dirs::home_dir();
1437 let other = crate::channel::install_dirs(home.as_deref())
1438 .into_iter()
1439 .flat_map(|dir| names.iter().map(move |name| dir.join(name)))
1440 .find(|candidate| candidate.is_file() && candidate != exe);
1441
1442 if let Some(other) = other {
1443 println!();
1444 output::print_info(&format!(
1445 "You already have a copy outside this project, at `{}`, so removing this one \
1446 still leaves you a working `devp`.",
1447 other.display()
1448 ));
1449 }
1450}
1451
1452#[cfg(test)]
1453mod tests {
1454 use super::*;
1455
1456 #[test]
1457 fn a_report_with_only_present_items_is_silent() {
1458 let mut report = SetupReport::default();
1459 report.push("a", Outcome::AlreadyPresent);
1460 assert!(!report.changed_anything());
1461 assert!(!report.needs_attention());
1462 }
1463
1464 #[test]
1465 fn skipped_and_failed_both_ask_for_attention() {
1466 let mut skipped = SetupReport::default();
1467 skipped.push("a", Outcome::Skipped("no git".into()));
1468 assert!(skipped.needs_attention());
1469 assert!(!skipped.changed_anything());
1470
1471 let mut failed = SetupReport::default();
1472 failed.push("a", Outcome::Failed("boom".into()));
1473 assert!(failed.needs_attention());
1474 }
1475
1476 #[test]
1477 fn an_install_counts_as_a_change() {
1478 let mut report = SetupReport::default();
1479 report.push("a", Outcome::Installed);
1480 assert!(report.changed_anything());
1481 }
1482
1483 #[test]
1484 fn the_skill_export_lands_in_the_config_directory() {
1485 let dir = tempfile::TempDir::new().unwrap();
1486 assert_eq!(ensure_skill_file_in(dir.path()), Outcome::Installed);
1487 // A second pass finds byte-identical content and leaves it alone.
1488 assert_eq!(ensure_skill_file_in(dir.path()), Outcome::AlreadyPresent);
1489 let written = fs::read_to_string(dir.path().join("SKILL.md")).unwrap();
1490 assert_eq!(written, EMBEDDED_SKILL_MD);
1491 }
1492
1493 #[test]
1494 fn a_stale_skill_export_is_rewritten() {
1495 // An upgrade must not leave the previous version's instructions on disk.
1496 let dir = tempfile::TempDir::new().unwrap();
1497 fs::write(dir.path().join("SKILL.md"), "# an older version").unwrap();
1498 assert_eq!(ensure_skill_file_in(dir.path()), Outcome::Installed);
1499 let written = fs::read_to_string(dir.path().join("SKILL.md")).unwrap();
1500 assert_eq!(written, EMBEDDED_SKILL_MD);
1501 }
1502
1503 #[test]
1504 fn agent_skills_install_only_into_agent_homes_that_exist() {
1505 let home = tempfile::TempDir::new().unwrap();
1506 assert!(
1507 agent_skill_roots_under(home.path()).is_empty(),
1508 "a machine without an agent must detect nothing"
1509 );
1510
1511 fs::create_dir_all(home.path().join(constants::CLAUDE_HOME_DIR)).unwrap();
1512 let roots = agent_skill_roots_under(home.path());
1513 assert_eq!(roots.len(), 1);
1514
1515 assert_eq!(ensure_agent_skills_at(&roots), Outcome::Installed);
1516 let installed = home
1517 .path()
1518 .join(constants::CLAUDE_HOME_DIR)
1519 .join(constants::AGENT_SKILLS_SUBDIR)
1520 .join(constants::APP_NAME)
1521 .join("SKILL.md");
1522 assert_eq!(fs::read_to_string(&installed).unwrap(), EMBEDDED_SKILL_MD);
1523
1524 // A second pass finds it current and leaves it alone.
1525 assert_eq!(ensure_agent_skills_at(&roots), Outcome::AlreadyPresent);
1526 }
1527
1528 #[test]
1529 fn refreshing_rewrites_the_copies_that_exist_and_creates_none() {
1530 let dir = tempfile::TempDir::new().unwrap();
1531 let present = dir.path().join("SKILL.md");
1532 fs::write(&present, "# the instructions from two releases ago").unwrap();
1533 let never_installed = dir.path().join("no-agent-here").join("SKILL.md");
1534
1535 let stale = stale_among(vec![present.clone(), never_installed.clone()]);
1536 assert_eq!(stale, vec![present.clone()]);
1537
1538 refresh_stale(stale);
1539 assert_eq!(fs::read_to_string(&present).unwrap(), EMBEDDED_SKILL_MD);
1540 assert!(
1541 !never_installed.exists(),
1542 "a machine that never had a copy must not acquire one from a refresh"
1543 );
1544 }
1545
1546 #[test]
1547 fn no_detected_agent_is_a_skip_not_a_failure() {
1548 assert!(matches!(ensure_agent_skills_at(&[]), Outcome::Skipped(_)));
1549 }
1550
1551 #[test]
1552 fn the_stamp_gates_the_unattended_pass() {
1553 let dir = tempfile::TempDir::new().unwrap();
1554 assert!(setup_is_due_in(dir.path()), "a fresh install is due");
1555 write_stamp_in(dir.path());
1556 assert!(
1557 !setup_is_due_in(dir.path()),
1558 "the same version is not due twice"
1559 );
1560 fs::write(dir.path().join(STAMP_FILE), "0.0.1").unwrap();
1561 assert!(setup_is_due_in(dir.path()), "an upgrade is due again");
1562 }
1563
1564 /// The alias must never be written with a copy while it already exists.
1565 ///
1566 /// A hard link and its target share one inode, so `fs::copy` onto the alias empties
1567 /// the binary it was copied from. This reproduces the exact shape of that bug — link
1568 /// first, then ask for the alias again — and asserts the original still has its
1569 /// bytes. The real failure was silent: a zero-byte executable that macOS runs
1570 /// through `/bin/sh`, which exits 0 and prints nothing.
1571 #[test]
1572 fn refreshing_an_alias_that_is_a_hard_link_does_not_empty_the_binary() {
1573 let dir = tempfile::TempDir::new().unwrap();
1574 let binary = dir.path().join("dev-prune");
1575 let alias = dir.path().join("devp");
1576 fs::write(&binary, vec![b'M'; 4096]).unwrap();
1577
1578 if fs::hard_link(&binary, &alias).is_err() {
1579 return; // Filesystem without hard links; the hazard cannot arise.
1580 }
1581
1582 // What `ensure_alias` does when its `hard_link` loses the race: the alias is
1583 // already there, so it must stop rather than fall through to the copy.
1584 assert!(fs::hard_link(&binary, &alias).is_err(), "EEXIST expected");
1585 assert!(alias.exists(), "the guard's condition");
1586
1587 assert_eq!(
1588 fs::metadata(&binary).unwrap().len(),
1589 4096,
1590 "the running binary was truncated by refreshing its own alias"
1591 );
1592 }
1593
1594 /// The on-disk file name for one of the pair, on this platform.
1595 fn exe_name(stem: &str) -> String {
1596 if cfg!(windows) {
1597 format!("{stem}.exe")
1598 } else {
1599 stem.to_string()
1600 }
1601 }
1602
1603 #[test]
1604 fn dev_prune_creates_devp_beside_it() {
1605 let dir = tempfile::TempDir::new().unwrap();
1606 let canonical = dir.path().join(exe_name("dev-prune"));
1607 fs::write(&canonical, "the binary").unwrap();
1608
1609 assert_eq!(ensure_twin_of(&canonical, dir.path()), Outcome::Installed);
1610 let alias = dir.path().join(exe_name("devp"));
1611 assert!(alias.is_file(), "`devp` was not created");
1612 assert_eq!(fs::read_to_string(&alias).unwrap(), "the binary");
1613 }
1614
1615 /// The pair has to be recoverable from either side.
1616 ///
1617 /// Deleting `dev-prune` and leaving `devp` is not hypothetical: an antivirus
1618 /// quarantine, a half-finished uninstall, or a `Remove-Item` aimed at one name all
1619 /// produce it. Before this, `devp setup` reported the alias already present and did
1620 /// nothing, because the only direction it knew how to repair was the other one.
1621 #[test]
1622 fn devp_restores_a_missing_dev_prune() {
1623 let dir = tempfile::TempDir::new().unwrap();
1624 let alias = dir.path().join(exe_name("devp"));
1625 fs::write(&alias, "the binary").unwrap();
1626
1627 assert_eq!(ensure_twin_of(&alias, dir.path()), Outcome::Installed);
1628 let canonical = dir.path().join(exe_name("dev-prune"));
1629 assert!(canonical.is_file(), "`dev-prune` was not put back");
1630 assert_eq!(fs::read_to_string(&canonical).unwrap(), "the binary");
1631 }
1632
1633 /// `devp` may create `dev-prune`, never overwrite it.
1634 ///
1635 /// Repairing in both directions opens a downgrade: an upgrade replaces `dev-prune`
1636 /// first and can then fail on a `devp` that is running, which leaves the alias holding
1637 /// the *older* binary. If the alias were allowed to refresh its twin from there, the
1638 /// next `devp setup` would quietly reinstall the version the user just upgraded away
1639 /// from — and report it as a repair.
1640 #[test]
1641 fn devp_does_not_overwrite_an_existing_dev_prune() {
1642 let dir = tempfile::TempDir::new().unwrap();
1643 let alias = dir.path().join(exe_name("devp"));
1644 let canonical = dir.path().join(exe_name("dev-prune"));
1645 fs::write(&alias, "the previous version").unwrap();
1646 fs::write(&canonical, "the version just upgraded to").unwrap();
1647
1648 assert_eq!(
1649 ensure_twin_of(&alias, dir.path()),
1650 Outcome::AlreadyPresent,
1651 "`devp` must leave an existing `dev-prune` alone"
1652 );
1653 assert_eq!(
1654 fs::read_to_string(&canonical).unwrap(),
1655 "the version just upgraded to",
1656 "`devp` downgraded the binary it was supposed to leave alone"
1657 );
1658 }
1659
1660 /// The same downgrade, coming the other way — the direction the gate above lets
1661 /// through.
1662 ///
1663 /// `devp` is blocked from refreshing `dev-prune` outright, but `dev-prune` refreshing
1664 /// `devp` was gated on nothing but the two files differing, on the assumption that the
1665 /// canonical name is always the newer one. Restore a `dev-prune` from a backup, or run
1666 /// one out of a package-manager cache, and it is not — and `devp doctor --fix` runs
1667 /// `ensure_alias` from whichever binary is executing, so an older `dev-prune` would
1668 /// delete a newer `devp` and link its own content over it while reporting a repair.
1669 #[test]
1670 fn a_twin_that_is_not_behind_is_left_alone() {
1671 assert!(
1672 !twin_is_stale(Some((1, 12, 0)), Some((1, 11, 0))),
1673 "a newer twin must not be overwritten"
1674 );
1675 assert!(
1676 !twin_is_stale(Some((1, 11, 0)), Some((1, 11, 0))),
1677 "an equal twin has nothing to refresh"
1678 );
1679 assert!(
1680 twin_is_stale(Some((1, 10, 0)), Some((1, 11, 0))),
1681 "a genuinely older twin is what this refresh is for"
1682 );
1683 // Neither side able to state a version leaves the old content-only rule, which is
1684 // the only answer available: whatever the file is, it is not a working build of
1685 // this CLI, and leaving it would keep a broken `devp` on PATH forever.
1686 assert!(twin_is_stale(None, Some((1, 11, 0))));
1687 assert!(twin_is_stale(Some((1, 11, 0)), None));
1688 }
1689
1690 #[test]
1691 fn versions_parse_strictly_or_not_at_all() {
1692 assert_eq!(parse_version("1.2.3"), Some((1, 2, 3)));
1693 assert_eq!(parse_version("10.0.0"), Some((10, 0, 0)));
1694 // Anything this project does not publish must answer None, because a None
1695 // means "replace the copy" and a mis-parse would order versions wrongly.
1696 assert_eq!(parse_version("1.2"), None);
1697 assert_eq!(parse_version("1.2.3.4"), None);
1698 assert_eq!(parse_version("1.2.3-rc1"), None);
1699 assert_eq!(parse_version("dev-prune"), None);
1700 // The version this binary was built with has to be parseable, or the refresh
1701 // logic can never decide anything.
1702 assert!(parse_version(constants::VERSION).is_some());
1703 }
1704
1705 #[test]
1706 fn the_version_this_cli_prints_is_one_this_cli_can_read_back() {
1707 // Not synthetic: this is the shape `print_version_info` writes, `v` and all,
1708 // down to the banner line that ends in the same token.
1709 let real = format!(
1710 "|_____| v{v}
1711
1712dev-prune (devp) v{v}
1713 Compiler: Rust 1.88+ (edition 2024)
1714",
1715 v = constants::VERSION
1716 );
1717 assert_eq!(
1718 version_in_output(&real),
1719 parse_version(constants::VERSION),
1720 "binary_version could not read this binary's own --version output"
1721 );
1722 // Something that is not this CLI still has to answer None, because doctor uses
1723 // that to mean "leave this file alone".
1724 assert_eq!(version_in_output("git version 2.51.0.windows.1"), None);
1725 assert_eq!(version_in_output("some other tool"), None);
1726 }
1727
1728 #[test]
1729 fn ordering_of_version_triples_matches_semver() {
1730 assert!(parse_version("1.1.0") > parse_version("1.0.9"));
1731 assert!(parse_version("2.0.0") > parse_version("1.99.99"));
1732 assert!(parse_version("1.0.10") > parse_version("1.0.9"));
1733 }
1734
1735 #[test]
1736 fn the_exported_skill_is_the_one_the_binary_was_built_with() {
1737 // `SKILL.md` is embedded, so a doc edit ships only if the binary is rebuilt.
1738 // Guard the two properties every consumer of it depends on.
1739 assert!(EMBEDDED_SKILL_MD.starts_with("---"), "needs frontmatter");
1740 assert!(
1741 !EMBEDDED_SKILL_MD.contains("file:///"),
1742 "SKILL.md is written to every user's machine — it must not contain \
1743 absolute paths from the author's checkout"
1744 );
1745 }
1746}