Repository navigation
Fix onboarding quickstart bugs and guard destructive cactus clean - #722
Merged
Merged
Conversation
- README: drop the broken `cactus transcribe` (errors without --file) from the Mac quick demo; keep the working `cactus run`. - README + docs/quickstart.md: install python3.12/python3.12-venv on Linux to match setup's hard python3.12 requirement (docs said python3, so `source ./setup` dead-ended). - cactus clean: stop silently deleting weights/, transpiled/, and venv/. Help now states it removes weights+venv; add --yes/-y; prompt for confirmation before deleting and refuse on non-interactive stdin unless --yes is passed.
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
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.
Three low-lift fixes from a repo cleanliness pass. No C++ touched; Python + docs only.
Changes
1. README quick demo no longer leads with a broken command.
cactus transcriberequires--file(required=True), so the bare command in the Mac quick demo errored immediately. Dropped it; kept the workingcactus run.2. Linux install docs match
setup's Python requirement.setuphard-requirespython3.12, but README (Step 0) anddocs/quickstart.mdtold users toapt-get install python3 python3-venv, sosource ./setupdead-ended with "python3.12 is not installed". Both now installpython3.12/python3.12-venv. (README ASCII box re-padded to stay aligned.)3.
cactus cleanno longer silently deletes weights + venv.cmd_cleanremovesweights/,transpiled/, andvenv/, but both help strings said only "delete build artifacts", with no confirmation. Downloaded weights are not re-fetched bysetup, so this was permanent data loss.--yes/-yto skip the prompt.[y/N]; on non-interactive stdin it refuses unless--yesis passed.Testing
Targeted verification (the engine
cactus testsuite is C++-only and doesn't exercise CLI/docs):cactus --help/cactus clean --helpshow the updated text and--yes/-y.rmtree/unlinktripwires proving zero deletions: non-TTY refuse, interactivenabort (rc=0),--yesbypass.weights/+venv/inodes and child counts identical before/after a guard run; repo integrity confirmed (only 4 files changed, no deletions).