config

package

v0.4.13 Latest Latest Go to latest Published: Aug 20, 2026 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/goforj/atlas

Links

Open Source Insights

Documentation ¶

Overview ¶

Package config reads and writes project-owned Atlas installation state.

Index ¶

Constants
func FilePath(root string) string
func Save(root string, cfg Config) error
type Config
- func Default() Config
- func Load(root string) (Config, error)
type DiscoverySnapshot
type Features
type OwnershipRuleConfig

Constants ¶

View Source

const CurrentVersion = 2

CurrentVersion is the current persisted Atlas config format version.

Variables ¶

This section is empty.

Functions ¶

func FilePath ¶

func FilePath(root string) string

FilePath returns the conventional Atlas config path for a project root.

func Save ¶

func Save(root string, cfg Config) error

Save writes the Atlas config to a project root.

Types ¶

type Config ¶

type Config struct {
	Version        int                   `json:"version"`
	Features       Features              `json:"features"`
	Agents         []string              `json:"agents"`
	Skills         []string              `json:"skills"`
	GeneratedFiles map[string][]string   `json:"generated_files,omitempty"`
	OwnershipRules []OwnershipRuleConfig `json:"ownership_rules,omitempty"`
	LastDiscovered DiscoverySnapshot     `json:"last_discovered"`
}

Config describes project-owned Atlas installation state.

func Default ¶

func Default() Config

Default returns the default Atlas configuration.

func Load ¶

func Load(root string) (Config, error)

Load reads the Atlas config from a project root.

type DiscoverySnapshot ¶

type DiscoverySnapshot struct {
	Apps       []string `json:"apps,omitempty"`
	Components []string `json:"components,omitempty"`
}

DiscoverySnapshot stores the last project facts Atlas used during install or update.

type Features ¶

type Features struct {
	Guidelines bool `json:"guidelines"`
	Skills     bool `json:"skills"`
	MCP        bool `json:"mcp"`
}

Features records which Atlas surfaces should be kept synchronized.

type OwnershipRuleConfig ¶ added in v0.3.0

type OwnershipRuleConfig struct {
	Pattern         string `json:"pattern"`
	Classification  string `json:"classification"`
	Editable        bool   `json:"editable"`
	PreferredAction string `json:"preferred_action,omitempty"`
	ChangeThrough   string `json:"change_through,omitempty"`
	Reason          string `json:"reason,omitempty"`
}

OwnershipRuleConfig describes a project-owned file ownership override.

Source Files ¶

View all Source files

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