brief

Documentation

Overview

Package brief generates a concise project overview (OK-BRIEF.md) that gives the AI agent immediate context at session start. Inspired by Stacklit (github.com/glincker/stacklit): ~250 tokens of structure knowledge replaces 50k+ tokens of initial exploration.

The brief is regenerated on codegraph init and can be manually triggered with `codegraph brief`. It is loaded into the agent's system prompt at session start via the memory system.

Index

• Constants
• func Content(dir string) string
• func Generate(dir string) error

Constants

const FileName = "OK-BRIEF.md"

FileName is the name of the generated brief file.

Functions

func Content

func Content(dir string) string

Content returns the brief as a string without writing to disk.

func Generate

func Generate(dir string) error

Generate creates a project brief in the given directory. It scans the directory structure, identifies key files (go.mod, Makefile, etc.), and writes a concise markdown summary to OK-BRIEF.md.

The brief is designed to be ~200-400 tokens — small enough to load into every session without meaningful cost, but informative enough to orient the agent immediately.