feat: add package installation instructions to AGENTS.md during brin init#44
Merged
feat: add package installation instructions to AGENTS.md during brin init#44
Conversation
When agents_md is enabled during brin init, append a Package Installation section to AGENTS.md instructing agents to use brin instead of npm/pip. The section is only added if it does not already exist (idempotent). Closes #36
Contributor
Author
|
@cursor review |
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
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.
Summary
Closes #36
During
brin init, after the docs index is written toAGENTS.md, also append a## Package Installationsection instructing agents to usebrininstead ofnpm install,yarn add,pnpm add, orpip install.The section is only added if it doesn't already exist (idempotent), so re-running
brin initis safe.Changes
crates/cli/src/agents_md.rs: Addedadd_install_instructions()public function and internaladd_install_instructions_at_path()with 3 new testscrates/cli/src/commands/init.rs: Callagents_md::add_install_instructions()after docs index step and print success messageOutput after change