Versions in this module Expand all Collapse all v1 v1.1.2 Aug 27, 2026 v1.1.1 Aug 27, 2026 v1.1.0 Aug 27, 2026 Changes in this version + type UpgradeReport struct + Current string + Path string + Previous string + Updated bool + func Upgrade(ctx context.Context, executable string) (*UpgradeReport, error) v1.0.0 Aug 26, 2026 Changes in this version + const ContextNotice + const DefaultBudget + const DefaultContextDays + const DefaultFindDays + const DefaultFindLimit + const EdgeFieldCount + const EdgeFieldSeparator + const EdgeLink + const EdgeSchemaVersion + const EdgeTag + const FindPhasePage + const FindPhaseRecord + const FindPhaseVolume + const MaxDroppedReported + const MaxEdgeLineBytes + const MaxEdgeListRows + const MaxFindPageLimit + const MaxGraphDepth + const NoFindLimit + const PresetMinimal + const PresetPersonal + const PresetTeam + const RankingVersion + var BundledSkills = []string + var EdgeColumns = []string + var ErrContextBudgetTooSmall = errors.New("context budget too small") + var ErrDerivedMissing = errors.New("derived file not built") + var ErrEdgeControl = errors.New("edge field contains a control or invisible character") + var ErrEdgeIncomplete = errors.New("edge is missing a required field") + var ErrEdgeLineTooLong = errors.New("edge line exceeds the record size limit") + var ErrEdgeListTooBig = errors.New("edge list exceeds the row limit") + var ErrEdgeSeparator = errors.New("edge field contains a separator byte") + var ErrEdgeTime = errors.New("edge timestamp is not canonical") + var ErrJQExpression = errors.New("invalid jq expression") + var ErrPartial = errors.New("collection was incomplete") + var ErrURI = errors.New("invalid URI") + var Presets = []string + var ProjectStatuses = []string + func AnchorSlug(heading string) string + func BaseAgentsTemplate(name string) string + func EncodeEdges(writer io.Writer, edges []Edge) error + func EnsureManagedBlock(path, block string) (bool, error) + func FindInvisible(value string) (rune, string, bool) + func ManagedAttributesBlock() string + func ManagedIgnoreBlock(trackCollected bool) string + func NodeKind(uri string) string + func ReadEventDocument(base *Base, date, source string) (*sources.Document, error) + func ReadEventDocumentContext(ctx context.Context, base *Base, date, source string) (*sources.Document, error) + func ReadIndexDocument(base *Base, name string) (*sources.Document, error) + func ReadIndexDocumentContext(ctx context.Context, base *Base, name string) (*sources.Document, error) + func RelativeLink(fromRelative, target string) string + func SortEdges(edges []Edge) + func SortFindRecords(records []FindRecord) + func SortSearchHits(hits []SearchHit) + func SuggestURIs(ctx context.Context, base *Base, raw string) []string + func TracksCollected(root string) (bool, error) + func ValidateDate(value string) error + func WriteEdgeList(path, metaPath string, edges []Edge, meta EdgeListMeta) error + type Base struct + Config *core.Config + Env sources.Environment + Now func() time.Time + Origin core.BaseOrigin + Runner sources.Runner + Store core.Store + func Open(explicit string) (*Base, error) + func (b *Base) DayDocuments(date string) ([]string, error) + func (b *Base) EventDates() ([]string, error) + func (b *Base) Exists(relative string) bool + func (b *Base) IndexDocuments() ([]string, error) + func (b *Base) ReadDocument(relative string) (*sources.Document, error) + func (b *Base) ReadDocumentContext(ctx context.Context, relative string) (*sources.Document, error) + func (b *Base) ReadFile(relative string, limit int64) ([]byte, error) + func (b *Base) ReadFileContext(ctx context.Context, relative string, limit int64) ([]byte, error) + func (b *Base) RequireLayer(layer core.Layer) error + func (b *Base) RequireTrust(ctx context.Context) error + func (b *Base) Root() string + func (b *Base) RunBody(ctx context.Context, source *core.Source, fields sources.Fields, ...) (string, error) + func (b *Base) Source(name string) (*core.Source, error) + func (b *Base) Timeout(source *core.Source) time.Duration + func (b *Base) WriteDocument(document *sources.Document) error + type BoundedFindResult struct + Next *FindPosition + Result *FindResult + SnapshotSHA256 string + func FindBounded(ctx context.Context, base *Base, filter FindFilter, counting bool, limit int, ...) (*BoundedFindResult, error) + type BuildReport struct + Graph *GraphBuild + Wiki *WikiIndexReport + func Build(ctx context.Context, base *Base, target string, check bool) (*BuildReport, error) + type ContextBudgetError struct + Minimum int + Requested int + func (e *ContextBudgetError) Error() string + func (e *ContextBudgetError) Unwrap() error + type ContextItem struct + Date string + Excerpt string + Fields map[string][]string + Kind string + Pinned bool + Reasons []Reason + Score int + Source string + Status string + Tags []string + Time string + Title string + Tokens int + URI string + URL string + type ContextPack struct + Items []ContextItem + Query string + Receipt Receipt + func BuildContext(ctx context.Context, base *Base, request ContextRequest) (*ContextPack, error) + type ContextRequest struct + Budget int + Expand bool + Explain bool + Pins []string + Query string + Window Window + type DayCount struct + Body bool + Count int + Source string + URI string + type DayVolume struct + Date string + Sources []SourceCount + Total int + type DemoReport struct + Base string + Days int + Pages int + Records int + Since string + Sources []string + Until string + func WriteDemo(ctx context.Context, base *Base, days int) (*DemoReport, error) + type DemoSource struct + Fields sources.Fields + Layer core.Layer + Name string + type Direction string + const DirectionBoth + const DirectionIn + const DirectionOut + func ParseDirection(value string) (Direction, error) + type DroppedItem struct + Pinned bool + Reason string + Score int + Tokens int + URI string + type Edge struct + At string + Dst string + Indexed string + Kind string + Src string + Via string + func DecodeEdge(line []byte) (Edge, bool) + func DedupeEdges(edges []Edge) []Edge + func ExtractEdges(ctx context.Context, base *Base) ([]Edge, extractCounts, error) + func (e Edge) Valid() error + type EdgeListMeta struct + Bytes int + Columns []string + DocumentsSHA256 string + Edges int + Extractors []string + GeneratedAt string + InputsSHA256 string + SHA256 string + SchemaVersion int + Separator string + func NewEdgeListMeta(edges []Edge, generatedAt time.Time, documentsSHA256, inputsSHA256 string) (EdgeListMeta, error) + type EdgeQuery struct + Dst string + Kind string + Src string + func (q EdgeQuery) Match(edge Edge) bool + type EdgeScanStats struct + Lines int + Malformed int + Matched int + func ScanEdges(ctx context.Context, reader io.Reader, query EdgeQuery, visit func(Edge) error) (EdgeScanStats, error) + type EntityView struct + NeighbourCap bool + Neighbours []Edge + Scheme Scheme + URI string + Value string + type EventDay struct + Date string + Sources []DayCount + Total int + URI string + type EventListing struct + Days []EventDay + Total int + Window Window + func ListEvents(ctx context.Context, base *Base, window Window, source string, limit int) (*EventListing, error) + type FindFilter struct + Grep []string + Layers []core.Layer + Limit int + Sources []string + Where []WhereClause + Window Window + type FindPosition struct + Date string + Phase string + Score int + Time string + URI string + type FindRecord struct + Body bool + Date string + Fields map[string][]string + Record sources.Record + Source string + Time string + Title string + URI string + URL string + type FindResult struct + Days []string + Matched int + Pages []SearchHit + Records []FindRecord + Scanned int + Truncated bool + Volumes []DayVolume + Window Window + func Find(ctx context.Context, base *Base, filter FindFilter, counting bool) (*FindResult, error) + type Finding struct + Check string + Fix string + Message string + Paths []string + Severity Severity + type GraphBuild struct + Documents int + Edges int + Elapsed string + Meta EdgeListMeta + Mode string + Pages int + URI string + func BuildGraph(ctx context.Context, base *Base) (*GraphBuild, error) + type GraphQuery struct + Depth int + Direction Direction + Kind string + Limit int + Offset int + URI string + type GraphSummary struct + EdgeKinds []KindCount + Edges int + Extractors []string + GeneratedAt string + NodeKinds []KindCount + Nodes int + Stats EdgeScanStats + URI string + func SummarizeGraph(ctx context.Context, base *Base) (*GraphSummary, error) + type Heading struct + Anchor string + Level int + Line int + Text string + type HelperReport struct + Base string + Current int + Drifted int + Helpers []HelperStatus + Missing int + Refreshed int + func InspectHelpers(ctx context.Context, base *Base, refresh bool) (*HelperReport, error) + type HelperState string + const HelperCurrent + const HelperDrifted + const HelperMissing + type HelperStatus struct + CurrentSHA256 string + Name string + Path string + Refreshed bool + Required bool + ShippedSHA256 string + State HelperState + type IndexEntry struct + AgeHours int + Bytes int64 + CollectedAt string + Count int + Name string + Stale bool + URI string + type IndexListing struct + Entries []IndexEntry + Total int + func ListIndex(ctx context.Context, base *Base, limit int) (*IndexListing, error) + type InitReport struct + Base string + Created bool + Declared int + Demo *DemoReport + Enabled int + Name string + Next []string + Preset string + Refreshed bool + Steps []InitStep + TrackCollected bool + Trusted bool + func Init(ctx context.Context, request InitRequest, now func() time.Time) (*InitReport, error) + type InitRequest struct + Demo int + Name string + Path string + Preset string + SkipGit bool + SkipValidate bool + TrackCollected bool + type InitStep struct + Changed bool + Detail string + Item string + type Issue struct + Line int + Message string + Severity Severity + URI string + type KindCount struct + Count int + Kind string + type LayerOverview struct + Count int + Enabled bool + Layer core.Layer + Note string + Since string + URI string + Unit string + Until string + type LearnedBullet struct + Harvested bool + Text string + Trace string + type LearnedListing struct + Bullets []LearnedBullet + Harvested int + Unharvested int + Window Window + func ListLearned(ctx context.Context, base *Base, window Window, onlyUnharvested bool) (*LearnedListing, error) + type Link struct + Line int + Target string + Title string + Via string + type NeighbourEdge struct + Hop int + type Neighbourhood struct + Depth int + Direction Direction + Edges []NeighbourEdge + Nodes []string + Skipped int + SnapshotSHA256 string + Stats EdgeScanStats + Truncated bool + URI string + func Neighbours(ctx context.Context, base *Base, query GraphQuery) (*Neighbourhood, error) + type NewKind string + const NewKindHelper + const NewKindProject + const NewKindTask + const NewKindWiki + func ParseNewKind(value string) (NewKind, error) + type NewRequest struct + Kind NewKind + Now func() time.Time + Slug string + Tags []string + Title string + Type string + type NewResult struct + Created bool + Kind NewKind + Message string + Path string + Requires []string + Run []string + URI string + func CreateNew(base *Base, req NewRequest) (*NewResult, error) + type NodeCount struct + In int + Kind string + Out int + Total int + URI string + type NodeListing struct + Kind string + Nodes []NodeCount + Stats EdgeScanStats + Total int + func ListNodes(ctx context.Context, base *Base, kind string, limit int) (*NodeListing, error) + type Page struct + Body string + Bytes int + Date string + Description string + Frontmatter map[string]any + Headings []Heading + Links []Link + Relations map[string][]string + Slug string + Status string + Tags []string + Title string + Type string + URI string + Updated string + func ParsePage(uri string, data []byte, modified time.Time) (Page, error) + func ReadPage(base *Base, uri string) (Page, error) + func ReadPageBySlug(base *Base, layer core.Layer, slug string) (Page, error) + func ReadPageBySlugContext(ctx context.Context, base *Base, layer core.Layer, slug string) (Page, error) + func ReadPageContext(ctx context.Context, base *Base, uri string) (Page, error) + func ReadTaskTrace(base *Base, reference string) (Page, error) + func ReadTaskTraceContext(ctx context.Context, base *Base, reference string) (Page, error) + type PageFilter struct + Limit int + Status string + Tags []string + Type string + type PageListing struct + Layer core.Layer + Pages []Page + Total int + func ListPages(ctx context.Context, base *Base, layer core.Layer, filter PageFilter) (*PageListing, error) + type ReadOptions struct + Body bool + Limit int + Offset int + type ReadResult struct + Body string + BodyState string + Date string + Document *sources.Document + Entity *EntityView + Entries []string + Kind string + Page *Page + Record sources.Record + Selection json.RawMessage + SnapshotSHA256 string + Source string + Text string + URI string + func Read(ctx context.Context, base *Base, raw string, options ReadOptions) (*ReadResult, error) + type Reason struct + Detail string + Points int + Reason string + type Receipt struct + AsOf string + Budget int + Candidates int + Dropped []DroppedItem + DroppedTotal int + EncodedTokens int + Floor int + InputDigest string + NewestEventDay string + Notice string + Query string + RankingVersion int + RejectedPins []string + Selected int + StaleDays int + Terms []string + ToolVersion string + UnharvestedBullets int + UsedTokens int + Warning string + Window Window + type RequirementStatus struct + Name string + OnPath bool + type Scheme string + const SchemeExternal + const SchemeFile + const SchemeTag + type SearchHit struct + Date string + Excerpt string + Layer core.Layer + Matched []string + Score int + Slug string + Tags []string + Title string + Type string + URI string + type SearchResult struct + Hits []SearchHit + Layer core.Layer + Terms []string + func SearchPages(ctx context.Context, base *Base, layer core.Layer, terms []string, ...) (*SearchResult, error) + type Severity string + const SeverityError + const SeverityWarning + type SkillState struct + Current bool + Digest string + Name string + Present bool + URI string + Written bool + func InstallSkills(root string) ([]SkillState, error) + func SkillDrift(root string) ([]SkillState, error) + type SourceCount struct + Count int + Source string + type SourceStatus struct + Body bool + Days int + Enabled bool + Install string + Kind core.Layer + LagHours int + LastCollectedAt string + LastCount int + LastDate string + Median int + Name string + Quiet bool + QuietReason string + Requires []RequirementStatus + Stale bool + Undeclared bool + type Status struct + Base string + Enabled int + Errors int + Findings []Finding + Graph *GraphSummary + LastSync string + Layers []LayerOverview + MaxAge int + Missing int + Name string + Next []string + OK bool + Origin core.BaseOrigin + Quiet int + Sources []SourceStatus + Stale bool + StaleDays int + TrackCollected bool + Trust core.TrustState + Unharvested int + Versioned bool + Warnings int + func Report(ctx context.Context, base *Base, request StatusRequest) (*Status, error) + type StatusRequest struct + All bool + MaxAgeHours int + SkipGitAudit bool + type SyncOutcome string + const OutcomeFailed + const OutcomeFresh + const OutcomePlanned + const OutcomeSkipped + const OutcomeWritten + type SyncPreview struct + Count int + Date string + Kind core.Layer + Sample []FindRecord + Source string + type SyncReport struct + Base string + Complete bool + DryRun bool + Elapsed string + Failed int + Graph *GraphBuild + Preview *SyncPreview + Records int + Skipped int + Units []SyncUnit + Window Window + Written int + func Sync(ctx context.Context, base *Base, request SyncRequest) (*SyncReport, error) + func (r *SyncReport) FailureSummary() string + type SyncRequest struct + Date string + Days int + DryRun bool + Force bool + NoGraph bool + Preview bool + Targets []string + type SyncUnit struct + Attempts int + Command string + Count int + Date string + Elapsed string + Error string + Kind core.Layer + Outcome SyncOutcome + Source string + URI string + type TagCount struct + Count int + Pages []string + Tag string + type TagVocabulary struct + Layer core.Layer + Pages int + Tags []TagCount + Untagged []string + func BuildTagVocabulary(ctx context.Context, base *Base, layer core.Layer) (*TagVocabulary, error) + type TaskListing struct + Traces []TaskTrace + Window Window + func ListTasks(ctx context.Context, base *Base, window Window, limit int) (*TaskListing, error) + type TaskTrace struct + Bytes int + Date string + Slug string + Title string + URI string + type TrustReport struct + All bool + Base string + Bin []string + Commands []TrustedSource + Policy TrustedBasePolicy + Recorded bool + Scripts []core.BinScript + State core.TrustState + func Trust(ctx context.Context, base *Base, record, all bool) (*TrustReport, error) + type TrustedBasePolicy struct + Concurrency int + Days int + Environment string + IndexMaxAgeHours int + Layers map[core.Layer]bool + Timeout string + WorkingDirectory string + type TrustedSource struct + Body []string + BodyFields core.FieldMap + Enabled bool + Layer core.Layer + Name string + Policy string + Run []string + type URI struct + Dir bool + Fragment string + JQ string + Path string + Raw string + Scheme Scheme + Value string + func ParseURI(raw string) (URI, error) + func ResolveLink(fromRelative, target string) (URI, error) + func (u URI) FileURI() string + func (u URI) IsEntity() bool + func (u URI) NodeURI() string + func (u URI) String() string + type ValidationReport struct + Errors int + Issues []Issue + Layer core.Layer + OK bool + Pages int + Strict bool + Warnings int + func ValidateMarkdownLayer(ctx context.Context, base *Base, layer core.Layer, requireStatus, strict bool) (*ValidationReport, error) + type VerifyFinding struct + Problem string + URI string + type VerifyReport struct + Base string + Documents int + Findings []VerifyFinding + OK bool + Records int + func Verify(ctx context.Context, base *Base) (*VerifyReport, error) + type WhereClause struct + Path core.FieldPath + Value string + func ParseWhere(argument string) (WhereClause, error) + type WikiIndexReport struct + Changed bool + Created bool + Pages int + Stale bool + Tags int + Types int + URI string + func BuildWikiIndex(ctx context.Context, base *Base, write bool) (*WikiIndexReport, error) + type Window struct + Since string + Until string + func ParseWindow(since, until string, now time.Time) (Window, error) + func (w Window) Contains(date string) bool
Go to main page