Repository navigation
docs: make install commands work against published npm versions - #141
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d844686814
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ```bash | ||
| npm exec --yes --package=codebase-context@2.4.0 -- codebase-context-review --base origin/main --head HEAD | ||
| npm exec --yes --package=codebase-context -- codebase-context-review --base origin/main --head HEAD |
There was a problem hiding this comment.
The unpinned package currently resolves to 2.2.0, whose bin map exposes only codebase-context; codebase-context-review was added later. Consequently this copy-paste command and the JSON variant below fail for the release that line 7 says these commands use. Explicitly state that these commands require the future release, rather than presenting the unpinned current package as executable.
AGENTS.md reference: AGENTS.md:L112-L112
Useful? React with 👍 / 👎.
| Technical reference for the current Codebase Context npm release and the upcoming 2.4.0 source. Start with the repository map, then search for relevant code. For an overview, see [README.md](../README.md). | ||
|
|
||
| **These commands use 2.4.0.** If that version is not available on npm yet, use the published 2.2.0 [setup guide](https://github.com/PatrickSys/codebase-context/blob/10ba0a635ff73cd5c5b011ffd5b31e7ed4656c65/docs/client-setup.md). | ||
| Commands use the current npm release. Features marked as planned for 2.4.0 are not yet available from npm; the current published version is 2.2.0. |
There was a problem hiding this comment.
Labeling this page as a reference for the current npm release leaves projects[].parsing.maxChunks described below as “supported today,” but that setting was introduced after 2.2.0 and the published parser does not recognize it. A user following the new unpinned commands can therefore configure a larger project and silently remain capped at 5,000 chunks; mark that option as 2.4.0-only or retain a version-specific 2.2.0 reference.
AGENTS.md reference: AGENTS.md:L112-L112
Useful? React with 👍 / 👎.
| ### Team patterns and examples | ||
|
|
||
| `get_team_patterns` shows the approaches used in the repository and points to representative files. Version `2.4.0` includes dedicated analyzers for Angular, React, Next.js and NestJS, with a generic analyzer for other stacks. | ||
| `get_team_patterns` shows the approaches used in the repository and points to representative files. Dedicated analyzers for Angular, React, Next.js and NestJS are planned for 2.4.0, which is not yet published on npm; the current npm release is 2.2.0. |
There was a problem hiding this comment.
Do not group Angular, React, and Next.js with the unpublished NestJS analyzer: the published 2.2.0 package already exports dedicated analyzers for those first three frameworks. This wording incorrectly tells current-release users that all four are merely planned and implies their projects use only the generic analyzer; only NestJS and the later analyzer improvements should be described as upcoming.
Useful? React with 👍 / 👎.
 [Low impact] The changes reach documentation readers following this package's install and usage instructions. Fix the published wizard recipes before merging; they do not create the connection the guide promises. FindingsSummaryReplaces unpublished version pins with the unpinned npm package name.
Reviews (1) · Last reviewed commit: "docs: use published npm install commands" · Reviewed by Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| npx -y codebase-context init --client claude-code --yes | ||
|
|
||
| # Codex | ||
| npx -y codebase-context@2.4.0 init --client codex --yes | ||
| npx -y codebase-context init --client codex --yes |
There was a problem hiding this comment.
The unpinned init --client … --yes commands select published 2.2.0, which ignores these arguments and asks interactive questions. It registers Claude Code and Codex against HTTP instead of writing the promised project-local stdio configs. Users still need a separately running server to connect.
Keep these recipes marked as source-only until their implementation is published, or document the published wizard's actual behavior.
There was a problem hiding this comment.
Fixed in 4bacc27. The init --client ... --yes section is now labelled "Requires 2.4.0 (not yet published)", both commands are pinned to codebase-context@2.4.0, and the text says that init with no flags on 2.2.0 starts the older interactive wizard. The release-truth test allows a 2.4.0 pin only next to that note.
| ### Team patterns and examples | ||
|
|
||
| `get_team_patterns` shows the approaches used in the repository and points to representative files. Version `2.4.0` includes dedicated analyzers for Angular, React, Next.js and NestJS, with a generic analyzer for other stacks. | ||
| `get_team_patterns` shows the approaches used in the repository and points to representative files. Dedicated analyzers for Angular, React, Next.js and NestJS are planned for 2.4.0, which is not yet published on npm; the current npm release is 2.2.0. |
There was a problem hiding this comment.
The new wording puts Angular, React and Next.js analyzers in the unpublished 2.4.0 bucket, but 2.2.0 already registers all three. This tells readers that existing framework support requires a future release. Separate those shipped analyzers from the planned NestJS support here and in the matching limitations text.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
There was a problem hiding this comment.
Fixed in 4bacc27. The README Team patterns paragraph and the README limitations bullet now say the Angular, React and Next.js analyzers ship in published 2.2.0. Only NestJS support, plus the React/Next.js detection improvements and reranker fix, is described as planned for 2.4.0. The matching text in docs/capabilities.md (analyzer list and limitations) is updated the same way.
Addresses Codex/Greptile review on #141: Angular/React/Next.js analyzers ship in 2.2.0 (only NestJS is upcoming); init --client/--yes, codebase-context-review and parsing.maxChunks require unpublished 2.4.0, so those commands are pinned and labelled. Release-truth test allows 2.4.0 pins only next to a 'requires 2.4.0' note.
1 participant
Root cause
The docs pinned installs to
codebase-context@2.4.0, whilepackage.jsondeclares 2.3.0 and npm currently publishes only through 2.2.0 (latest=2.2.0). Release-please PR #124 for 2.4.0 has remained open and was never merged, so neither 2.3.0 nor 2.4.0 was published.Changes
npxand MCP configuration examples to use the unpinned package name, so npm resolves the current published release.CI protection
The unit test scans the user-facing install docs for version-pinned
codebase-context@x.y.zreferences and fails when a pin differs from the expected published 2.2.0. The normal recipes stay unpinned, which follows the npm release automatically.Release boundary
Publishing 2.4.0, including merging #124 or running the release, is the owner's call. This PR does not publish, create a release or tag, or modify #124.
Overlap with open PRs
The minimal documentation changes overlap README, CLI and release-truth test files also changed by #140;
docs/client-setup.mdoverlaps #139. The edits are limited to install versions and truthful release wording.Verification
pnpm run buildpnpm run lint(0 errors; existing warnings)pnpm test(90 files, 667 tests passed)