docs: document heph tool clean - #89
Open
raphaelvigee wants to merge 2 commits into
Open
Conversation
heph adds `heph tool clean <selection>` (hephbuild/heph#357) — removes every cached revision of the selected target(s), regardless of the history budget and whether or not the target still exists, as a targeted counterpart to `heph tool gc`. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Cabo8vZ6e78QQWULEbAoG3
⚡ Cloudflare Pages preview
|
Member
Author
|
Add some comment about how you should not normally need this and instead should track down why a cache clean is required, its probably a target configuration issue |
Per review feedback on #89: reaching for `heph tool clean` regularly on an unchanged target is a symptom of an under-declared input, not something to build a workflow around. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Cabo8vZ6e78QQWULEbAoG3
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
heph added
heph tool clean <selection>in hephbuild/heph#357 (commit 4464a00) — a new CLI subcommand that removes every cached revision of the selected target(s), regardless of thehistoryretention budget and whether or not the target still exists. It's the targeted counterpart to the existingheph tool gcsweep.This PR documents it in the two places that cover
heph toolcommands:website/docs/concepts/caching.md— added a paragraph + example block under "Reclaiming space", next to the existingheph tool gccoverage.plugins/heph-expert/skills/heph/references/cli.md— added a row to theheph toolsubcommand table (the reference-drift rule in this repo'sCLAUDE.md).website/docs/reference/cli.mdis auto-generated byheph gen-docsand was intentionally left untouched.Selection syntax and behavior (address / label+matcher /
-eexpr, theallwildcard, no whole-cache default) were verified directly againstsrc/commands/tool/clean.rs,src/commands/tool/mod.rs, andsrc/commands/utils.rson the hephmasterbranch, not assumed from the PR description alone.Test plan
🤖 Generated with Claude Code
https://claude.ai/code/session_01Cabo8vZ6e78QQWULEbAoG3
Generated by Claude Code