catalog

package module

Go to main page

Versions in this module

v0

v0.3.4

Aug 21, 2026

v0.3.3

Aug 21, 2026

v0.3.2

Aug 21, 2026

v0.3.1

Aug 21, 2026

v0.3.0

Aug 20, 2026

Changes in this version

type Capability

+ const CapabilityExplorer

+ const CapabilityExplorerExport

+ const CapabilityReadOnlyMCP

v0.2.0

Jul 25, 2026

Changes in this version

+ var ErrCorpusEscape = errors.New("catalog: corpus path escapes the corpus root")

+ var ErrDecode = errors.New("catalog: decode failed")

+ var ErrDuplicateEntityID = errors.New("catalog: duplicate entity id")

+ var ErrEmptyQuery = errors.New("catalog: query has no usable terms")

+ var ErrHostAllowlistRequired = errors.New("catalog: public_url requires a non-empty host allowlist")

+ var ErrIndexCorrupt = errors.New("catalog: index is corrupt")

+ var ErrIndexMissing = errors.New("catalog: index missing")

+ var ErrIndexSchema = errors.New("catalog: unsupported index schema")

+ var ErrInvalidEntity = errors.New("catalog: invalid entity")

+ var ErrInvalidLayout = errors.New("catalog: invalid layout")

+ var ErrInvalidProvider = errors.New("catalog: invalid provider")

+ var ErrPolicyViolation = errors.New("catalog: projection policy violation")

+ var ErrProhibitedContent = errors.New("catalog: prohibited public content")

+ var ErrProviderFailed = errors.New("catalog: provider failed")

+ var ErrPublicURLRejected = errors.New("catalog: public_url rejected")

+ func EntityIDPattern() string

+ func ScanPublicText(field, value string) error

+ func ValidateEntityID(id string) error

type BuildInfo

+ Modified bool

+ func (b BuildInfo) Has(capability Capability) bool

+ type Capability string

+ const CapabilityBM25Search

+ const CapabilityDrift

+ const CapabilityGraph

+ const CapabilityLayout

+ const CapabilityProviders

+ const CapabilityPublicProjection

+ const CapabilityReconcile

+ const CapabilityReindex

+ const CapabilitySyntheticDemo

+ const CapabilityValidate

+ func Capabilities() []Capability

+ type CorpusDecision struct

+ Reason SkipReason

+ Skip bool

+ type CorpusPolicy struct

+ CaseFoldExtensions bool

+ Extensions []string

+ SkipDirNames []string

+ SkipDotPrefixedDirs bool

+ SkipUnderscorePrefixedDirs bool

+ SkipUnderscorePrefixedFiles bool

+ func DefaultCorpusPolicy() CorpusPolicy

+ func StrictMarkdownCorpusPolicy() CorpusPolicy

+ func (p CorpusPolicy) DecideDir(name string) CorpusDecision

+ func (p CorpusPolicy) DecideFile(name string) CorpusDecision

+ func (p CorpusPolicy) Normalize() CorpusPolicy

+ type DecodeError struct

+ Err error

+ Path string

+ func (e *DecodeError) Error() string

+ func (e *DecodeError) Unwrap() error

+ type DuplicateIDError struct

+ EntityID string

+ First RecordOrigin

+ Second RecordOrigin

+ func (e *DuplicateIDError) Error() string

+ func (e *DuplicateIDError) Unwrap() error

+ type EntityError struct

+ EntityID string

+ Err error

+ Field string

+ Provider string

+ Source string

+ func (e *EntityError) Error() string

+ func (e *EntityError) Unwrap() error

type FilesystemProvider

+ Policy CorpusPolicy

+ type IndexError struct

+ Err error

+ Path string

+ func (e *IndexError) Error() string

+ func (e *IndexError) Unwrap() error

+ type Limits struct

+ MaxEntities int

+ MaxRecordsPerProvider int

+ MaxSearchResults int

+ MaxSourceBytes int64

+ MaxSummaryBytes int

+ func DefaultLimits() Limits

+ func (l Limits) Validate() error

+ type Option func(*engineConfig) error

+ func WithLimits(limits Limits) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithProviders(providers ...Provider) Option

+ type PolicyError struct

+ EntityID string

+ Err error

+ Field string

+ Rule PolicyRule

+ func (e *PolicyError) Error() string

+ func (e *PolicyError) Unwrap() error

+ type PolicyRule string

+ const RuleCredentialPair

+ const RuleInternalPath

+ const RuleInvalidUTF8

+ const RulePathDisclosure

+ const RuleTokenShape

+ const RuleURLCredentials

+ const RuleURLHost

+ const RuleURLPort

+ const RuleURLQuery

+ const RuleURLScheme

+ const RuleVisibility

type ProjectionPolicy

+ ExcludeTags []string

+ TruncationSuffix string

+ URLMode URLMode

+ func (p ProjectionPolicy) Validate() error

+ type ProviderError struct

+ Err error

+ Provider string

+ Source string

+ func (e *ProviderError) Error() string

+ func (e *ProviderError) Unwrap() error

+ type ReconcileMode int

+ const ReconcileApply

+ const ReconcileDryRun

+ func (m *ReconcileMode) UnmarshalJSON(payload []byte) error

+ func (m ReconcileMode) MarshalJSON() ([]byte, error)

+ func (m ReconcileMode) String() string

+ func (m ReconcileMode) Valid() bool

type ReconcileReport

+ Mode ReconcileMode

type Record

+ SourceDigest string

+ type RecordOrigin struct

+ Provider string

+ Source string

+ type Severity string

+ const SeverityError

+ const SeverityWarning

+ type SkipReason string

+ const SkipDeniedDir

+ const SkipDotDir

+ const SkipNone

+ const SkipUnderscoreDir

+ const SkipUnderscoreFile

+ const SkipUnknownExtension

+ type URLMode int

+ const URLModeAllowlist

+ const URLModeDrop

+ type ValidateOption func(*validateConfig) error

+ func WithStrictReferences() ValidateOption

+ type ValidationIssue struct

+ Detail string

+ EntityID string

+ Kind ValidationIssueKind

+ Severity Severity

+ type ValidationIssueKind string

+ const IssueDanglingReference

+ const IssueDuplicateReference

+ const IssueSelfReference

type ValidationReport

+ Errors []ValidationIssue

+ type Visibility string

+ const VisibilityInternal

+ const VisibilityPrivate

+ const VisibilityPublic

+ func (v Visibility) String() string

+ func (v Visibility) Valid() bool

v0.1.1

Jul 23, 2026

v0.1.0

Jul 23, 2026

Changes in this version

+ const SchemaVersion

+ var Commit = "unknown"

+ var Version = "v0.1.0"

+ type BuildInfo struct

+ Capabilities []string

+ Commit string

+ SchemaVersion int

+ Version string

+ func VersionInfo() BuildInfo

+ type Document struct

+ EntityID string

+ Length int

+ TermFrequency map[string]int

+ type DriftReport struct

+ ActualDigest string

+ Changed bool

+ ExpectedDigest string

+ OK bool

+ Reason string

+ type Engine struct

+ func New(layout Layout, providers ...Provider) (*Engine, error)

+ func (e *Engine) Discover(ctx context.Context) ([]Record, error)

+ func (e *Engine) Drift(ctx context.Context) (DriftReport, error)

+ func (e *Engine) Layout() Layout

+ func (e *Engine) LoadIndex() (Index, error)

+ func (e *Engine) Reconcile(ctx context.Context, apply bool) (ReconcileReport, error)

+ func (e *Engine) Reindex(ctx context.Context) (ReindexReport, error)

+ func (e *Engine) Search(query string, options SearchOptions) ([]SearchResult, error)

+ func (e *Engine) Validate(ctx context.Context) (ValidationReport, error)

+ type Entity struct

+ Annotations map[string]string

+ Description string

+ Entrypoint string

+ ID string

+ Kind string

+ Name string

+ Owner string

+ PublicURL string

+ Refs []Ref

+ Status string

+ Surface string

+ Tags []string

+ Visibility string

+ type FilesystemProvider struct

+ ExcludeDirs []string

+ ProviderName string

+ Strict bool

+ func (p FilesystemProvider) Name() string

+ func (p FilesystemProvider) Provide(ctx context.Context, layout Layout) ([]Record, error)

+ type Graph struct

+ Edges []GraphEdge

+ Nodes []GraphNode

+ func BuildGraph(index Index) Graph

+ func (g Graph) Mermaid() string

+ type GraphEdge struct

+ Kind string

+ Source string

+ Target string

+ type GraphNode struct

+ ID string

+ Kind string

+ Name string

+ Status string

+ type Index struct

+ AverageDocumentLength float64

+ Documents []Document

+ Entities []Entity

+ SchemaVersion int

+ SourceDigest string

+ type Layout struct

+ CacheDir string

+ ConfigDir string

+ CorpusDir string

+ SidecarDataDir string

+ func DefaultLayout(root string) Layout

+ func (l Layout) Resolve(root string) (Layout, error)

+ func (l Layout) Validate() error

+ type ProjectionPolicy struct

+ AllowHosts []string

+ IncludeKinds []string

+ IncludeTags []string

+ MaxSummaryBytes int

+ RequireVisibility string

+ type Provider interface

+ Name func() string

+ Provide func(context.Context, Layout) ([]Record, error)

+ type PublicConnection struct

+ Kind string

+ Target string

+ type PublicEntity struct

+ Connections []PublicConnection

+ ID string

+ Kind string

+ Name string

+ Status string

+ Summary string

+ Tags []string

+ URL string

+ type PublicProjection struct

+ Items []PublicEntity

+ SchemaVersion int

+ func ProjectPublic(index Index, policy ProjectionPolicy) (PublicProjection, error)

+ type ReconcileReport struct

+ Applied bool

+ Drift DriftReport

+ Reindex *ReindexReport

+ type Record struct

+ Digest string

+ Entity Entity

+ Provider string

+ Source string

+ type Ref struct

+ Kind string

+ Target string

+ type ReindexReport struct

+ DocumentCount int

+ EntityCount int

+ IndexPath string

+ OK bool

+ SourceDigest string

+ type SearchOptions struct

+ Kinds []string

+ Limit int

+ type SearchResult struct

+ Entity Entity

+ MatchedTerms []string

+ Score float64

+ type StaticProvider struct

+ Entities []Entity

+ ProviderName string

+ func (p StaticProvider) Name() string

+ func (p StaticProvider) Provide(_ context.Context, _ Layout) ([]Record, error)

+ type ValidationReport struct

+ EntityCount int

+ OK bool

+ ProviderCount int

+ Warnings []string

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