docs

package

v1.0.0 Latest Latest Go to latest Published: Sep 28, 2026 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/mas-bandwidth/nova-tools

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Check(root string, cat []Entry) []string
func Render(root string, cat []Entry) (map[string]string, []string)
func RepoRoot() (string, error)
func RunAgentsMap(args []string) error
func Write(root string, pages map[string]string) error
type CatalogIndex
- func IndexCatalog(cat []Entry) (CatalogIndex, []string)
type Entry
- func E(path, purpose, guard, command string) Entry
- func Page(path, purpose, guard, command string) Entry

Constants ¶

View Source

const MaxRootBytes = 3 * 1024

MaxRootBytes is the ceiling on the root AGENTS.md. A harness reads that page at the start of every session, so a map that grows without a cap stops being read.

View Source

const RootAgents = "AGENTS.md"

Variables ¶

View Source

var DefaultCatalog = []Entry{}/* 104 elements not displayed */

DefaultCatalog is the master catalog for nova-tools.

Functions ¶

func Check ¶

func Check(root string, cat []Entry) []string

Check holds the committed pages against a fresh Render. A mapped directory that grew a child, a catalog row that was edited, or a hand-edit of a page all fail with "stale; run: make map".

func Render ¶

func Render(root string, cat []Entry) (map[string]string, []string)

Render builds every AGENTS.md page from the live tree and the catalog. Uncatalogued children still appear (as "-" rows) so a committed page goes stale the moment a mapped directory grows a child. Completeness issues are returned beside the pages; make map refuses to write when any are present.

func RepoRoot ¶

func RepoRoot() (string, error)

RepoRoot walks up from the current working directory to find Makefile.

func RunAgentsMap ¶

func RunAgentsMap(args []string) error

func Write ¶

func Write(root string, pages map[string]string) error

Types ¶

type CatalogIndex ¶

type CatalogIndex map[string]Entry

func IndexCatalog ¶

func IndexCatalog(cat []Entry) (CatalogIndex, []string)

type Entry ¶

type Entry struct {
	Path    string // slash-separated, no trailing slash
	Purpose string
	Guard   string
	Command string
	Page    bool // write Path/AGENTS.md listing this directory's children
}

Entry is one mapped directory.

func E ¶

func E(path, purpose, guard, command string) Entry

func Page ¶

func Page(path, purpose, guard, command string) Entry

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL