project

Aug 27, 2026

Changes in this version

+ func NewADRLeased(root string, cfg *config.Config, repo *awfgit.Repo, ctx context.Context, ...) (string, error)

+ func NewPlanLeased(root, title string, lease *filesystem.Lease, files *filesystem.Handle) (string, error)

type Loader

+ func (l *Loader) AcquireProjectLease(ctx context.Context, root string) (*filesystem.Lease, error)

+ func (l *Loader) CoversProjectLease(ctx context.Context, root string, lease *filesystem.Lease) bool

+ func (l *Loader) OpenForMutation(ctx context.Context, root string, files *filesystem.Handle) (*ProjectState, *config.Config, *filesystem.ExpectedIdentity, error)

Aug 25, 2026

Changes in this version

+ func AdvisoryNotes(state *ProjectState, cfg *config.Config, output outputplan.Plan, ...) ([]string, error)

+ func BuildListDocument(state *ProjectState, cfg *config.Config, kindFilter string) (presentation.Document, error)

+ func CheckStagedDriftResult(prep *ContextPreparation, plan outputplan.Plan) (checkresult.Result, error)

+ func NewADR(root string, cfg *config.Config, repo *awfgit.Repo, ctx context.Context, ...) (string, error)

+ func NewPitfall(root, title string) (presentation.Document, error)

+ func NewPlan(root, title string) (string, error)

+ type CheckAdvisories struct

+ Information []string

+ Warnings []string

type CheckReport

+ func BuildCheckReport(state *ProjectState, cfg *config.Config, repo *awfgit.Repo, ...) (CheckReport, error)

+ type ContextPreparation = currentstatecoord.ContextPreparation

+ func PrepareStagedContextState(ctx context.Context, root string) (*ContextPreparation, error)

type Loader

+ func (l *Loader) OpenForOperation(ctx context.Context, root string) (*ProjectState, *config.Config, error)

+ type OperationSemantics struct

+ ADRs adr.Corpus

+ EffectiveSkills map[string]bool

+ GeneratedOutput generatedcheck.AdditionalInput

+ Pitfalls pitfall.Corpus

+ Plans []plan.Plan

+ PlansError error

+ Topics topic.Corpus

+ Vocabulary vocabularycheck.Input

+ type ProjectState struct

+ func (s *ProjectState) Config() *config.Config

+ func (s *ProjectState) OutputState() *projectstate.ProjectState

+ func (s *ProjectState) Root() string

+ func (s *ProjectState) Targets() []Target

Aug 17, 2026

Changes in this version

+ func CheckVersionAuthority() error

Aug 15, 2026

Changes in this version

+ func RequireCapability(profile catalog.Profile, command string, fullOnly bool) error

+ func ScaffoldConfigForProfile(prefix string, vars map[string]string, scopes []string, ...) ([]byte, error)

+ type CapabilityError struct

+ Command string

+ Profile catalog.Profile

+ func (e *CapabilityError) Diagnostic() (presentation.Diagnostic, error)

+ func (e *CapabilityError) Error() string

type CheckReport

+ TrackingNotes []string

type Layout

+ Singletons map[string]string

Aug 12, 2026

Changes in this version

+ func IsLocalDocTemplate(templateID string) bool

type Project

+ func (p *Project) PreflightLocalDoc(ctx context.Context, doc config.LocalDoc) error

Aug 11, 2026

Changes in this version

+ func PitfallScaffoldDocument(sourcePath string) (presentation.Document, error)

+ type PitfallScaffoldCleanupError struct

+ Cause error

+ ResiduePath string

+ SourcePath string

+ func (e *PitfallScaffoldCleanupError) Diagnostic() (presentation.Diagnostic, error)

+ func (e *PitfallScaffoldCleanupError) Error() string

+ func (e *PitfallScaffoldCleanupError) Unwrap() error

type Project

+ func (p *Project) NewPitfall(title string) (document presentation.Document, returnErr error)

Aug 10, 2026

Changes in this version

type Project

+ func (p *Project) RenderResidentMarker(ctx context.Context, name string) (RenderedFile, error)

Aug 7, 2026

Changes in this version

type ContextState

+ PlanState PlanContext

+ type PlanContext struct

+ Plans []plan.Plan

+ func (c PlanContext) LinkedPlans(identity string) []string

+ type PlanReference struct

+ Filename string

+ Path string

Aug 5, 2026

Changes in this version

+ func CheckStagedDriftRoot(ctx context.Context, root string) ([]manifest.Drift, error)

+ func ConfigReferencePresentation(key string, model *ConfigReference, status string) (presentation.Document, error)

+ func CurrentStateCategories(report CurrentStateReport, staged bool) ([]presentation.ReportCategory, error)

+ func DriftCategories(drift []manifest.Drift, staged bool) ([]presentation.ReportCategory, error)

+ func EnablementNotesDocument(notes []EnablementNote) (presentation.Document, error)

+ func IsDocKind(singular string) bool

+ func IsFreeformDomainKind(singular string) bool

+ func IsGraphKind(singular string) bool

+ func IsSkillKind(singular string) bool

+ func PlanDocument(plan []PlanOp) (presentation.Document, error)

+ func SyncMutation(backups []Backup, changes []Change, pruned []string) (presentation.Mutation, error)

+ func ValidateSchemaMinimumVersion(schema int, version string) error

+ func VerifyCommitPolicyAt(ctx context.Context, root string, targets []string) (presentation.Document, commitpolicy.Outcome, error)

type Capability

+ const CapabilityEffortSessions

+ type CheckReport struct

+ Drift []manifest.Drift

+ Notes []string

+ PlanNotes []string

+ type CommitAuthorizationResult struct

+ Category string

+ ChangedIndex bool

+ ChangedMergeState bool

+ ChangedMessage bool

+ Condition string

+ NextActions []string

+ func (r CommitAuthorizationResult) Diagnostic() (presentation.Diagnostic, error)

+ type ConfigKeyRow struct

+ Availability string

+ Current string

+ Default string

+ Description string

+ Path string

+ Type string

+ type ConfigReference struct

+ ConfigKeys []ConfigKeyRow

+ DataKeys []DataKeyRow

+ SidecarFields []ConfigKeyRow

+ VarEntries []VarRow

+ func StaticConfigReference() (ConfigReference, error)

+ type ContextState struct

+ Cfg *config.Config

+ Declarations []OutputDeclaration

+ Eligible []string

+ Layout Layout

+ Loaded currentstate.Loaded

+ Lock *manifest.Lock

+ Tree *snapshot.Tree

+ func StagedContextState(ctx context.Context, root string) (ContextState, error)

type CurrentStateReport

+ PlanDrift []manifest.Drift

+ PlanNotes []string

+ Provisional []currentstate.Introduction

+ type DataKeyRow struct

+ Artifact string

+ Description string

+ Key string

+ State string

+ type EnablementNote struct

+ Kind string

+ Name string

+ Reason EnablementNoteReason

+ type EnablementNoteReason int

+ const EnablementNoteAgentNoLongerRequired

+ const EnablementNoteOrphanedAuthoredState

+ type LoadConfigTree func(string) (*config.Config, error)

+ type Loader struct

+ func NewLoader(loadConfigTree LoadConfigTree, standard *catalog.Catalog, ...) *Loader

+ func NewLoaderWithoutRepository(loadConfigTree LoadConfigTree, standard *catalog.Catalog, ...) *Loader

+ func (l *Loader) Open(ctx context.Context, root string) (*Project, error)

+ type NumberAssignment struct

+ Number string

+ Slug string

+ type NumberingReport struct

+ Assignments []NumberAssignment

+ func (r NumberingReport) Presentation() (presentation.Document, error)

type Project

+ func (p *Project) CheckCommitAuthorization(ctx context.Context, msg commitmsg.Message) (CommitAuthorizationResult, error)

+ func (p *Project) CheckReport(ctx context.Context) (CheckReport, error)

+ func (p *Project) CheckStagedDrift(ctx context.Context) ([]manifest.Drift, error)

+ func (p *Project) CommitPolicyPresentation(outcome commitpolicy.Outcome) (presentation.Document, error)

+ func (p *Project) ContextState(ctx context.Context) (ContextState, error)

+ func (p *Project) ListDocument(kindFilter string) (presentation.Document, error)

+ func (p *Project) NumberPendingADRs(ctx context.Context, slugs []string) (NumberingReport, error)

+ func (p *Project) ReadPlan(name, selector string) ([]byte, error)

+ func (p *Project) VerifyCommitPolicy(ctx context.Context, targets []string) commitpolicy.Outcome

+ type ResolveResidentRoot func(context.Context, string) string

type TargetOutput

+ RequiresSkill string

+ SkillName string

+ type VarRow struct

+ Availability string

+ Consumers string

+ Description string

+ Key string

+ State string

Jul 24, 2026

Changes in this version

+ type ADRArtifactContext struct

+ AuthorityRole string

+ Mutability string

+ Number string

+ Operations []ADROperationContext

+ Status string

+ Title string

+ type ADROperationContext struct

+ Claim string

+ ClaimState string

+ Detail *ADROperationDetail

+ Operation string

+ Progress string

+ StateSequence int

+ Topic string

+ type ADROperationDetail struct

+ Current *ClaimDetail

+ History *topic.ClaimHistory

+ MarkerSites []topic.MarkerSite

+ type ArtifactLink struct

+ Label string

+ Path string

+ type ArtifactRecord struct

+ Identity string

+ Navigation []ArtifactLink

+ Outputs []ArtifactLink

+ Role ArtifactRole

+ Snapshot *ArtifactSnapshot

+ Sources []ArtifactLink

+ type ArtifactRole string

+ const ArtifactAuthoredData

+ const ArtifactClaimPart

+ const ArtifactConfig

+ const ArtifactConventionPart

+ const ArtifactDecisionRecord

+ const ArtifactLock

+ const ArtifactManagedOutput

+ const ArtifactManifest

+ const ArtifactProtocolDescriptor

+ const ArtifactTemplate

+ const ArtifactTopicMetadata

+ type ArtifactSnapshot struct

+ Drifted bool

+ InManifest bool

type Capability

+ const CapabilitySessionHandoff

+ type ClaimDetail struct

+ Backing string

+ ID string

+ Prose string

+ References ClaimReferences

+ Sites []topic.MarkerSite

+ Type string

+ Verify string

+ type ClaimReferences struct

+ Incoming []string

+ Outgoing []string

+ type ContextPath struct

+ ADR *ADRArtifactContext

+ Artifacts []ArtifactRecord

+ Classification PathClassification

+ Domains []DomainRef

+ GlobLiteral bool

+ NestedRoot string

+ Path string

+ Requests []string

+ TargetInsideRepository *bool

+ Topics []PathTopicRef

+ type ContextProjection string

+ const ContextConcise

+ const ContextFull

+ type ContextRequest struct

+ EffectivePaths []string

+ Query string

+ Status RequestStatus

type ContextResult

+ Projection ContextProjection

+ Requests []ContextRequest

+ Topics []InvocationTopicContext

+ func StagedContextRoot(root string, paths []string) (ContextResult, error)

+ func StagedContextRootFull(root string, paths []string) (ContextResult, error)

+ func StagedContextRootFullGitSelection(root string, paths []string) (ContextResult, error)

+ func StagedContextRootGitSelection(root string, paths []string) (ContextResult, error)

+ type CurrentStateReport struct

+ Advisories []string

+ Coverage []topic.CoverageFinding

+ Static []currentstate.Finding

+ func CheckStagedRoot(root string) (CurrentStateReport, error)

+ func (r CurrentStateReport) Findings() []string

+ func (r CurrentStateReport) Notes() []string

+ type FullTopicContext struct

+ Claims []ClaimDetail

+ Pending []PendingChange

+ type InitAuthority struct

+ InitializedWithVersion string

+ type InvariantReport struct

+ Backing string

+ ID string

+ Proofs []string

+ Verify string

+ type InvocationTopicContext struct

+ Applicability TopicApplicabilityBrief

+ ClaimIDs []string

+ CoverageCommand string

+ DirectClaims []ClaimDetail

+ Full *FullTopicContext

+ ID string

+ OmittedDetailCount int

+ Summary string

+ Title string

+ TopicCommand string

type Layout

+ IndexMd string

+ type OutputDeclaration struct

+ Declarers []string

+ Dependencies []string

+ Inputs []OutputInput

+ Path string

+ Reservation bool

+ TemplateID string

+ func BuildOutputDeclarations(cfg *config.Config, cat *catalog.Catalog, targets []Target, ...) ([]OutputDeclaration, error)

+ type OutputInput struct

+ Path string

+ Role ArtifactRole

type OutputNode

+ ConsumedInputs []OutputInput

+ ObservedTemplateID string

+ type PathClassification string

+ const PathContextIgnored

+ const PathCovered

+ const PathEligibleUnowned

+ const PathGeneratedOutput

+ const PathNestedAdopter

+ const PathNotFound

+ const PathOutsideRepository

+ const PathSymlink

+ type PathTopicRef struct

+ DirectClaimIDs []string

+ ID string

+ type PendingChange struct

+ ADR string

+ Applied int

+ Claim string

+ Declared int

+ Op string

+ Status string

+ Title string

type Project

+ func (p *Project) CheckCurrentState() (CurrentStateReport, error)

+ func (p *Project) CheckStaged() (CurrentStateReport, error)

+ func (p *Project) ContextForFull(paths []string) (ContextResult, error)

+ func (p *Project) ContextForFullGitSelection(paths []string) (ContextResult, error)

+ func (p *Project) ContextForGitSelection(paths []string) (ContextResult, error)

+ func (p *Project) CurrentStateInvariants() ([]InvariantReport, error)

+ func (p *Project) InitializeReport(seed InitAuthority) ([]Backup, []Change, []string, error)

+ type ProjectTreeReader interface

+ Paths func(prefix string) []string

+ ReadFile func(path string) ([]byte, bool)

type RenderedFile

+ ConsumedInputs []OutputInput

+ ObservedTemplateID string

+ type RequestStatus string

+ const RequestDirectoryEmpty

+ const RequestDirectoryExpanded

+ const RequestGitSelected

+ const RequestLiteral

type Target

+ func (t Target) HiddenWorkflowPath(name string) string

+ func (t Target) WorkflowRouterPath() string

type TargetOutput

+ Inputs []TargetOutputInput

+ Producer TargetOutputProducer

+ type TargetOutputInput struct

+ Path string

+ Role ArtifactRole

+ type TargetOutputProducer string

+ const TargetOutputTelemetryProtocol

+ const TargetOutputTemplate

+ type TopicApplicabilityBrief struct

+ DeclaredGlobal bool

+ DomainPaths []string

+ MatchedPathCount int

+ TopicPaths []string

type UncoveredResult

+ Uncovered []UncoveredTopic

+ Unowned []UnownedEntry

+ func StagedUncoveredRoot(root string, scanRoots []string) (UncoveredResult, error)

+ type UncoveredTopic struct

+ Domain string

+ Path string

+ type UninstallReport struct

+ MetricsPreserved bool

+ Removed int

+ type UnownedEntry struct

+ ExcludedCount int

+ Path string

+ UnownedCount int

Jul 20, 2026

Changes in this version

+ const BridgeTrancheComplete

+ func NormalizeContextPaths(paths []string) []string

+ type AgentDialect string

+ const MarkdownAgentDialect

+ const PlainAgentDialect

+ const TOMLAgentDialect

+ type BridgeOutput struct

+ Bytes []byte

+ Deletion bool

+ DependencyHashes []string

+ Mode uint32

+ Path string

+ Policy OutputPolicy

+ Reservation bool

+ type Capability string

+ const CapabilitySubagentTools

type ContextResult

+ Background int

+ Governing []ADRRef

+ Pitfalls []PitfallRef

+ Plans []PlanRef

+ Related []ADRRef

+ type InvariantRef struct

+ Class string

+ Slug string

+ Touches []string

+ Verify string

+ type OutputNode struct

+ DeclarerProjections []string

+ Declarers []string

+ DependsOn []string

+ Path string

+ Policy OutputPolicy

+ Recipe OutputRecipe

+ Reservation bool

+ type OutputPlan struct

+ Nodes []OutputNode

+ type OutputPolicy struct

+ LocalValidation bool

+ Regenerate bool

+ ScanReferences bool

+ ScanSkillReferences bool

+ ValidateFrontmatter bool

+ type OutputRecipe struct

+ ConfigHash string

+ Encoder AgentDialect

+ Policy OutputPolicy

+ Provenance string

+ TemplateHash string

+ TemplateID string

+ type PitfallRef struct

+ Path string

+ Tags []string

+ Title string

+ type PlanRef struct

+ ADRs []int

+ Filename string

+ Path string

+ Status string

type Project

+ func (p *Project) BridgeProjection(terminal bool) ([]BridgeOutput, error)

+ func (p *Project) Corpus() (adr.Corpus, error)

+ func (p *Project) NewPlan(title string) (string, error)

+ func (p *Project) OutputPlan() (*OutputPlan, error)

+ func (p *Project) QueryTopic(selector string, opts topic.QueryOptions) (topic.QueryResult, error)

+ func (p *Project) Topics() (topic.Corpus, error)

+ func (p *Project) Uncovered(tracked, scanRoots []string) (UncoveredResult, error)

type RenderedFile

+ Declarer string

+ DeclarerProjection string

+ Encoder AgentDialect

+ Policy OutputPolicy

+ Provenance render.CommentStyle

+ RegenChecked bool

type Target

+ AgentDialect AgentDialect

+ AgentSuffix string

+ BridgeTemplate string

+ Capabilities []Capability

+ Outputs []TargetOutput

+ type TargetOutput struct

+ Encoder AgentDialect

+ Path string

+ Policy OutputPolicy

+ PolicyDeclared bool

+ Provenance render.CommentStyle

+ TemplateID string

+ type UncoveredResult struct

+ Entries []string

+ ScanRoots []string

Jul 11, 2026

Changes in this version

+ type ADRRef struct

+ Invariants []string

+ Number string

+ Path string

+ Status string

+ Title string

+ type ContextResult struct

+ ADRs []ADRRef

+ Domains []DomainRef

+ Invariants []string

+ Paths []string

+ Unowned []string

+ type DomainRef struct

+ CurrentState string

+ Name string

type PlanOp

+ Enable bool

type Project

+ func (p *Project) ContextFor(paths []string) (ContextResult, error)

+ func (p *Project) ResolveDisable(kind, name string) []PlanOp

+ func (p *Project) ResolveEnable(kind, name string) []PlanOp

Jul 11, 2026

Changes in this version

+ func DeriveDocTitle(name string) string

Jul 10, 2026

Changes in this version

+ func PotentialVarConsumers() (map[string][]string, error)

+ func ScaffoldVarRefs(kind string) ([]string, error)

type Project

+ func (p *Project) ConfigReferenceModel() (map[string]any, error)

Jul 10, 2026

Changes in this version

+ func NeededVars(trim *config.CatalogTrim) (map[string]bool, error)

+ type Change struct

+ Cause string

+ Path string

Jul 9, 2026

Changes in this version

+ type PlanOp struct

+ Add bool

+ Node catalog.Node

+ RequiredBy string

type Project

+ func (p *Project) ResolveAdd(kind, name string) []PlanOp

+ func (p *Project) ResolveRemove(kind, name string) []PlanOp

Jul 7, 2026

Changes in this version

type Project

+ func (p *Project) AdvisoryNotes() ([]string, error)

Jul 4, 2026

Changes in this version

type Layout

+ WorkingWithAwf string

Jul 3, 2026

Changes in this version

+ func CollisionsAt(root string, planned []string) []string

+ func HookNames() []string

type Layout

+ AgentsMdStandard string

+ DocStandard string

type Project

+ func (p *Project) NewADR(title string) (string, error)

+ func (p *Project) SkillsRequiringAgent(agent string) []string

+ func (p *Project) UnsetVarNotes() ([]string, error)

Jun 29, 2026

Changes in this version

+ func KnownTargets() []string

type Project

+ Targets []Target

Jun 29, 2026

Changes in this version

+ type Backup struct

+ Bak string

+ Index bool

+ Path string

type Project

+ func (p *Project) SyncReport() ([]Backup, error)

Jun 28, 2026

Changes in this version

+ const Version

+ func CatalogNames(cat *catalog.Catalog, singular string) ([]string, bool)

+ func EnabledNames(c *config.Config, singular string) ([]string, bool)

+ func Kinds() []string

+ func PluralKind(singular string) (string, bool)

+ func ScaffoldConfig(prefix string, vars map[string]string, inv *config.InvariantConfig, ...) ([]byte, error)

+ func Uninstall(root string) (int, error)

+ type Layout struct

+ ADRDir string

+ ActiveMd string

+ AdrReadme string

+ AdrTemplate string

+ Docs map[string]string

+ DocsDir string

+ DomainsDir string

+ PlansDir string

+ PlansReadme string

+ WorkflowRef string

+ type Project struct

+ Cat *catalog.Catalog

+ Cfg *config.Config

+ Root string

+ Target Target

+ func Open(root string) (*Project, error)

+ func (p *Project) Audit(baseOverride string) ([]audit.Finding, error)

+ func (p *Project) BackupFile(rel string) (string, error)

+ func (p *Project) Check() ([]manifest.Drift, error)

+ func (p *Project) CheckInvariants() ([]invariants.Finding, error)

+ func (p *Project) InitCollisions() ([]string, error)

+ func (p *Project) PlannedOutputs() ([]string, error)

+ func (p *Project) RenderAll() ([]RenderedFile, error)

+ func (p *Project) Sync() error

+ type RenderedFile struct

+ ConfigHash string

+ Content string

+ Path string

+ TemplateHash string

+ TemplateID string

+ type Target struct

+ AgentDir string

+ BridgeFile string

+ Name string

+ SkillDir string

+ func (t Target) AgentPath(name string) string

+ func (t Target) SkillPath(prefix, name string) string