Skip to content

feat: add package installation instructions to AGENTS.md during brin init#44

Merged
homanp merged 2 commits intomainfrom
feat/init-agents-install-instructions
Feb 18, 2026
Merged

feat: add package installation instructions to AGENTS.md during brin init#44
homanp merged 2 commits intomainfrom
feat/init-agents-install-instructions

Conversation

@homanp
Copy link
Contributor

@homanp homanp commented Feb 18, 2026

Summary

Closes #36

During brin init, after the docs index is written to AGENTS.md, also append a ## Package Installation section instructing agents to use brin instead of npm install, yarn add, pnpm add, or pip install.

The section is only added if it doesn't already exist (idempotent), so re-running brin init is safe.

Changes

  • crates/cli/src/agents_md.rs: Added add_install_instructions() public function and internal add_install_instructions_at_path() with 3 new tests
  • crates/cli/src/commands/init.rs: Call agents_md::add_install_instructions() after docs index step and print success message

Output after change

$ brin init

  🔧 initializing brin...

  Enable AGENTS.md docs index for AI coding agents? (Y/n) Y

  ✓ created brin.json
  ✓ created .brin-docs/
  ✓ updated AGENTS.md with brin docs index
  ✓ added package installation instructions to AGENTS.md

  ✓ brin initialized successfully!

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
@homanp
Copy link
Contributor Author

homanp commented Feb 18, 2026

@cursor review

@homanp homanp self-assigned this Feb 18, 2026
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@homanp homanp merged commit 873f7f1 into main Feb 18, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

brin init should add package installation instructions to AGENTS.md

1 participant

Comments