instructions

package
v0.0.0-...-f56615f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 2, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

Package instructions discovers directory-scoped project instruction files.

Index

Constants

View Source
const DefaultMaxBytes = 64 * 1024

Variables

This section is empty.

Functions

func FindProjectRoot

func FindProjectRoot(path string) string

Types

type Document

type Document struct {
	Path    string
	Content string
}

type Options

type Options struct {
	Root          string
	CWD           string
	FallbackNames []string
	MaxBytes      int
}

type Set

type Set struct {
	Root      string
	Documents []Document
}

func Discover

func Discover(options Options) (Set, error)

Discover walks from Root to CWD. In each directory, AGENTS.override.md wins over AGENTS.md and configured fallbacks. Files are never followed through a symlink, and the combined byte budget is enforced in discovery order.

func (Set) Sources

func (s Set) Sources() []string

func (Set) Text

func (s Set) Text() string

Jump to

Keyboard shortcuts

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