Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

repobrief

Generate a concise, deterministic AGENTS.md from the code already in a repository.

AI coding tools work better with clear local context, but hand-writing repository instructions is often postponed until a project becomes hard to understand. repobrief creates a reviewable first draft from detectable project metadata: ecosystem, source directories, existing guidance, and verified package scripts.

git clone https://github.com/K14-coder/repobrief.git
cd repobrief
node src/cli.js /path/to/your-repository --write

--write refuses to replace an existing AGENTS.md unless you add --force. Once published to npm, it can be invoked with npx repobrief.

Deliberately boring, deliberately safe

  • No model API key, account, or network connection
  • Does not read source-file contents
  • Produces deterministic Markdown that is easy to review in a pull request
  • Works with Node.js, Python, Rust, and Go projects today

Why this instead of an AI-generated architecture document?

The output is a starting point, not invented project knowledge. It avoids guessing at architecture and puts the verified commands and observed repository shape in one predictable file. Teams then add their conventions and ownership rules where they belong.

Development

npm test

Keywords

AGENTS.md generator, AI coding agents, repository context, Claude Code, Codex, Cursor, agent instructions, developer productivity.

License

MIT

About

Generate concise, deterministic AGENTS.md files from repository metadata.

Topics

Resources

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages