Repository navigation
docs: restructure public README and fix piped installer - #1012
AlexMikhalev wants to merge 7 commits into
Conversation
`curl ... | bash` exited 0 and installed nothing. When bash reads the script from stdin, BASH_SOURCE[0] is unset, so the guard compared an empty string with "bash" and never called main. Default to $0 so piped and direct runs both execute main, while sourcing still does not. Also correct the usage text: passing options through a pipe needs `bash -s --`, because `bash --with-cli` is an invalid bash option. Refs #3556 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Rebuild the README around a hero, contents table and categorised catalogue, modelled on analysis-tools-dev/static-analysis, and add an ecosystem section linking the related public repositories. Every documented command was run against the v1.21.22 binaries, and references to missing files, removed subcommands and non-existent packages were dropped. The bot-managed downloads block is unchanged. Refs #3556 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The options overwrote each other, so the documented combination installed only whichever came last. Add to the selection instead, without duplicates, and only suggest next steps for installed tools. Correct the README's checksum claim, which is conditional, and the invalid `| bash --with-cli` forms in docs/installation.md. Addresses structural review findings on PR #1012. Refs #3556 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Documentation PreviewYour documentation changes have been deployed to: This preview will be available until the PR is closed. |
The live badge displayed the current member count, which reads as a weak signal on a project landing page. Label the link instead. Refs #3556 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Documentation PreviewYour documentation changes have been deployed to: This preview will be available until the PR is closed. |
The list promised unconditional checksum verification and a fallback to source compilation. The installer can continue without checksums, with a warning, and has no source-build path. Refs #3556 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Structural review round 2 by SummaryThis round re-reviewed the public README refresh and installer corrections at The earlier findings are now addressed as follows:
Remaining suggestions:
No P0 or P1 findings remain. The remaining documentation defects are outside the two changed lines in Confidence Score: 4/5
Important Files Changed
Installer Flow%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Invoke install.sh] --> B{Invocation form}
B -->|curl pipe| C[bash -s -- OPTIONS]
B -->|executed file or process substitution| D[main receives OPTIONS]
B -->|source install.sh| E[Define functions only]
C --> F[parse_args]
D --> F
F --> G{Option}
G -->|--with-cli| H[add_tool terraphim-cli]
G -->|--with-grep| I[add_tool terraphim-grep]
G -->|--tool NAME| J[Replace default, then deduplicate]
H --> K[Install accumulated tools]
I --> K
J --> K
K --> L{Manifest has checksum?}
L -->|Yes| M[Verify SHA-256 and install]
L -->|No| N[Warn and install unverified]
M --> O[Print commands for installed tools only]
N --> O
style H fill:#d4edda,stroke:#28a745
style I fill:#d4edda,stroke:#28a745
style J fill:#d4edda,stroke:#28a745
style O fill:#d4edda,stroke:#28a745
Inline FindingsNo findings occur on changed diff lines.
|
| Command/check | Result |
|---|---|
git apply --numstat < ../pr1012.diff |
Confirmed changes to README.md, docs/installation.md and scripts/install.sh. |
/bin/bash --version |
GNU bash, version 3.2.57(1)-release, matching the requested compatibility target. |
/bin/bash -n scripts/install.sh scripts/platform-detection.sh scripts/binary-resolution.sh scripts/security-verification.sh |
Passed. |
shellcheck -s bash scripts/install.sh |
One pre-existing SC2034 warning for unused local resolved at line 270; no correctness errors relevant to this patch. |
Source installer, then parse_args --with-cli --with-grep |
Passed: count 3, tools terraphim-agent terraphim-cli terraphim-grep. |
Source installer, then parse_args --tool terraphim-cli --tool terraphim-grep |
Passed: count 2, with no retained default agent and no overwrite. |
Empty TOOLS_TO_INSTALL, then tool_selected x under set -euo pipefail |
Returned the expected non-match status without an unbound-array error. |
Empty-array length expansion under Bash 3.2 and set -u |
Passed, length 0. |
cat scripts/install.sh | /bin/bash -s -- --help |
Passed with exit 0. |
/bin/bash -c 'source scripts/install.sh; …' |
Passed; functions were loaded and main did not run. |
/bin/bash <(cat scripts/install.sh) --help |
Passed with exit 0. |
Extract and compare the README marker region against git show github/main:README.md |
Byte-identical: 1255 bytes on both sides. |
Python validation of relative Markdown links in README.md |
No missing local links. |
| Python validation of README heading anchors | All table-of-contents anchors resolve. The repeated bun-install heading is inside an example and does not invalidate any link. |
Recalculate hashes listed in scripts/SHA256SUMS |
All three helper checksums matched. |
| HTTP checks for the website, documentation, how-tos, editor, client releases, Homebrew repository and PyPI page | All returned HTTP 200. crates.io returned its usual automated-request 403; GHCR’s unauthenticated registry endpoint returned 401, which is expected for that API endpoint and does not disprove image availability. |
Inspect scripts/install.sh for Cargo/source-build logic |
No source-compilation path exists, contradicting docs/installation.md:27. |
git status --short after review |
Empty; the read-only worktree remained unchanged. |
One attempted repository-search batch used options unsupported by the locally installed terraphim-grep; the first query returned usage status 2, and several searches piped through head reported status 101 after their output pipe closed. Those results were not relied upon for findings.
Last reviewed commit: dd6fe55 | Reviews (2)
Documentation PreviewYour documentation changes have been deployed to: This preview will be available until the PR is closed. |
…badge The options on the second install command ran off the code block, so it read the same as the first. Wrap the line. Label the Discord link rather than showing a live count, matching the Discourse badge. Refs #3556 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Structural review round 3 by Structural re-review — Round 3Reviewed commit: Prior findingsBoth Round 2 P2 findings are resolved:
Commit FindingsP0None. P1None. P2None. The wider re-review of Required marker verificationThe
Confidence5/5 — Safe to merge with minimal risk. All P0/P1 issues are absent, both previous P2 findings are resolved, and no remaining P2 finding was identified. Commands run and resultsAll checks were read-only. No compilation, build, edit, commit, push or PR comment was performed.
No Cargo, Rust, Yarn, npm, Make or other build command was run. Last reviewed commit: 06965a9 | Reviews (3) |
Documentation PreviewYour documentation changes have been deployed to: This preview will be available until the PR is closed. |
|
Structural review round 4 by SummaryRound 4 verifies the documentation-only changes in commit
Round 3’s clean result remains valid. No new or remaining suggestions were identified. Confidence Score: 5/5
Important Files Changed
Findings
Commands Run
No compilation, build, edit, commit, push or remote comment was performed. Last reviewed commit: 7718d30 | Reviews (4) |
The source repository is private, but terraphim-skills.md is public. Refs #3556 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Documentation PreviewYour documentation changes have been deployed to: This preview will be available until the PR is closed. |
|
Structural review round 5 by Structural re-review — Round 5PR: #1012 Findings
Verification
Commands run and results
No compilation, build, edits, commits, pushes or comments were performed. Confidence: 5/5. |
Summary
curl ... | bashcurrently exits 0 and installs nothing, because the guard at the end ofscripts/install.shis false when bash reads from stdin.Corrected
ta.Thesaurus, which does not exist in terraphim-automata 1.0.0.LICENSE,desktop/README.md,docs/archive/...,quickwit_*_config.json).terraphim-agent commands, REPL/vm,/web,/file,/deploy,/sessions,brew install terraphim/terraphim-ai/terraphim-ai).terraphim-replcrate, and addedterraphim-grep, previously absent from the install docs.terraphim-skills, and@terraphim/autocomplete, whose published 1.3.0 package has no native binaries and cannot load.terraphimCargo registry.cargo fetchfails without one.Evidence
Run on macOS arm64 in isolated
HOMEdirectories:maincargo install terraphim_grep --locked,terraphim_agent --locked, emptyCARGO_HOMEupdate_release.py(pinned updater) on a copygithub/mainNot run:
yarn run dev,cargo run, Homebrew install (formula URL checked only), Linux. Three external citations return 403 to curl (Forbes, The Atlantic, Fandom) and were not changed.Notes for review
mainhas diverged, so this needs a separate sync. Follow-up decisions are tracked on Gitea issue terraphim/terraphim-ai#3556.🤖 Generated with Claude Code