Documentation
¶
Overview ¶
Package install coordinates Atlas agent installation and update workflows.
Index ¶
Constants ¶
const GuidanceReconciliationVersion = 1
GuidanceReconciliationVersion identifies the current host reconciliation contract.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AgentStatus ¶ added in v0.3.0
type AgentStatus struct {
Name string `json:"name"`
Configured bool `json:"configured"`
GuidelinesPresent bool `json:"guidelines_present"`
MCPPresent bool `json:"mcp_present"`
SkillsPresent bool `json:"skills_present"`
}
AgentStatus describes one agent's Atlas install state.
type GuidanceReconciliation ¶ added in v0.4.0
type GuidanceReconciliation struct {
Version int `json:"version"`
Enabled bool `json:"enabled"`
Targets []string `json:"targets"`
}
GuidanceReconciliation describes the native guideline projection that the host must reconcile.
type HostInstaller ¶ added in v0.4.0
type HostInstaller struct {
Installer Installer
}
HostInstaller coordinates Atlas state while leaving native guidance projection to the host.
func NewHostInstaller ¶ added in v0.4.0
func NewHostInstaller() HostInstaller
NewHostInstaller creates a HostInstaller with built-in agents when none are provided.
func (HostInstaller) Install ¶ added in v0.4.0
func (i HostInstaller) Install(ctx context.Context, request HostRequest) (HostResult, error)
Install writes Atlas-owned surfaces and returns native guidance reconciliation intent.
type HostRequest ¶ added in v0.4.0
type HostRequest struct {
Root string
Project project.Project
Agents []string
AllAgents bool
Discover bool
Guidelines *bool
Skills *bool
MCP *bool
NoInteraction bool
DryRun bool
}
HostRequest controls an installation whose native guidance files are reconciled by its host.
type HostResult ¶ added in v0.4.0
type HostResult struct {
Agents []string
Files []string
Guidance GuidanceReconciliation
}
HostResult describes Atlas-owned files and the native guidance reconciliation requested from the host.
type HostUpdater ¶ added in v0.4.0
type HostUpdater struct {
Installer Installer
}
HostUpdater refreshes Atlas-owned integration files and returns host reconciliation intent.
func NewHostUpdater ¶ added in v0.4.0
func NewHostUpdater() HostUpdater
NewHostUpdater creates a HostUpdater with the built-in installer.
func (HostUpdater) Update ¶ added in v0.4.0
func (u HostUpdater) Update(ctx context.Context, request HostRequest) (HostResult, error)
Update refreshes Atlas-owned surfaces without writing native guidance files.
type Installer ¶
Installer installs Atlas project guidance and agent configuration.
func NewInstaller ¶
NewInstaller creates an Installer with built-in agents when none are provided.
type Options ¶
type Options struct {
Root string
Project project.Project
Agents []string
AllAgents bool
Discover bool
Guidelines bool
Skills bool
MCP bool
NoInteraction bool
DryRun bool
}
Options controls an Atlas install or update run.
type SkillStatus ¶ added in v0.3.0
type SkillStatus struct {
Expected int `json:"expected"`
Present int `json:"present"`
Stale bool `json:"stale"`
Missing []string `json:"missing,omitempty"`
}
SkillStatus describes generated Atlas skill freshness.
type StatusOptions ¶ added in v0.3.0
type StatusOptions struct {
Root string
Project project.Project
Docs atlasdocs.Provider
Agents []agents.Agent
}
StatusOptions controls Atlas install status inspection.
type StatusResult ¶ added in v0.3.0
type StatusResult struct {
Installed bool `json:"installed"`
Project string `json:"project,omitempty"`
GoForjVersion string `json:"goforj_version,omitempty"`
DocsVersion string `json:"docs_version,omitempty"`
DocsRevision string `json:"docs_revision,omitempty"`
Agents []AgentStatus `json:"agents,omitempty"`
Skills SkillStatus `json:"skills"`
Warnings []string `json:"warnings,omitempty"`
}
StatusResult describes whether Atlas is installed, current, and aligned.
func Status ¶ added in v0.3.0
func Status(ctx context.Context, opts StatusOptions) (StatusResult, error)
Status inspects local Atlas installation state without modifying files.
Source Files