Where to Find Freebuff Documentation: A Complete Guide to the CodebuffAI Repository

Freebuff documentation is maintained directly inside the CodebuffAI/freebuff repository under the docs/ directory and scattered as inline README files across the monorepo packages.

The CodebuffAI team keeps all freebuff documentation version-controlled alongside the source code, ensuring that every commit updates both implementation and instructions simultaneously. Whether you are exploring agent capabilities, setting up the CLI, or integrating the SDK, the authoritative files live in predictable locations within the GitHub repository.

Core Documentation in the docs/ Directory

The primary hub for conceptual and procedural guides sits at the repository root in docs/.

Agents and Tools Reference

The file docs/agents-and-tools.md serves as the definitive guide to Freebuff’s agent architecture. It catalogs available agents, their prompt templates, and the built-in tools that agents invoke during execution. Consult this file first when configuring custom agents or debugging tool-related failures.

Testing Framework Guide

For contributors and advanced users, docs/testing.md outlines the testing strategy for the entire monorepo. It covers unit tests for the CLI, integration suites for the SDK, and agent-specific validation workflows.

Package-Level Inline Documentation

Beyond the central docs/ folder, each module maintains its own localized documentation in dedicated README files:

• cli/README.md – Installation steps, global commands, and flag references for the command-line interface.
• sdk/README.md – API surface documentation, import patterns, and programmatic usage examples.
• packages/agent-runtime/src/templates/README.md – Deep dive into agent runtime templates and tool definition schemas.
• packages/code-map/src/tree-sitter-queries/readme.md – Technical specifications for the Tree-sitter query system used in code mapping.

These files are deliberately co-located with their source code to keep implementation details synchronized with user-facing instructions.

Accessing Documentation Locally

You can browse the freebuff documentation without an internet connection by cloning the repository and opening the markdown files in any text editor or preview tool.

Clone the repository and view files via command line:

git clone https://github.com/CodebuffAI/freebuff.git
cd freebuff
cat docs/agents-and-tools.md | less

To generate a rendered HTML view locally, install a static site generator such as markdown-it:

npm install -g markdown-it
markdown-it docs/agents-and-tools.md > /tmp/agents.html
open /tmp/agents.html   # macOS; use xdg-open on Linux

Practical Example: Running a CLI Command

The cli/README.md demonstrates typical entry points that mirror the inline help text. After installing the package globally:

npm install -g freebuff
cd my-project
freebuff --help

The output of --help reflects the same usage patterns documented in cli/README.md, confirming that the code and documentation remain tightly coupled.

Summary

• Primary docs reside in docs/agents-and-tools.md and docs/testing.md at the repository root.
• README.md acts as the high-level entry point, linking to all sub-package documentation.
• Module-specific guides are located in cli/README.md, sdk/README.md, and within the packages/ directory tree.
• All documentation is stored as markdown files version-controlled in the CodebuffAI/freebuff repository.
• View files locally using standard Unix tools, VS Code preview, or static generators like markdown-it.

Frequently Asked Questions

Where is the main entry point for Freebuff documentation?

The top-level README.md in the CodebuffAI/freebuff repository serves as the main entry point. It provides quick-start instructions and hyperlinks to docs/agents-and-tools.md, docs/testing.md, and all package-level README files.

How do I view the documentation offline?

Clone the repository using git clone https://github.com/CodebuffAI/freebuff.git, then open any .md file in your preferred editor. You can read raw markdown in the terminal with cat or less, or render HTML locally using tools like markdown-it.

Are the documentation files version controlled?

Yes. Every markdown file lives inside the Git repository alongside the source code. This co-location ensures that documentation updates ship with the code changes they describe, preventing version drift between the implementation and the instructions.

Where can I find CLI-specific usage details?

Refer to cli/README.md for command-specific flags, installation procedures, and global configuration options. Running freebuff --help after installation will also display a synopsis that matches the content of this file.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}