magus

package module

Go to main page

Versions in this module

v0

v0.4.3

Sep 6, 2026

v0.4.2

Sep 3, 2026

v0.4.1

Sep 3, 2026

v0.4.0

Sep 2, 2026

Changes in this version

+ const BaseLastPassed

+ const CacheKeyVersion

+ const LockStaleAfter

+ func CatalogFingerprint() string

+ func CharmsForCI(charms []string) []string

+ func ListSpells(ctx context.Context) ([]types.Spell, error)

+ func ResolveCacheDir(root string, opts ...Option) (string, error)

+ func ShortRevision(id string) string

+ func SymbolGaps(ctx context.Context, ws types.Inspector, root string, cfg config.Config, ...) (gaps []types.KnowledgeSymbolGap, ok bool)

+ type CacheStats struct

+ Error int

+ Hit int

+ Miss int

+ SavedMs int64

+ type Command struct

+ Arguments []string

+ Cwd string

+ Trigger string

+ type Event struct

+ Command *Command

+ DurMs int64

+ Inv string

+ Kind string

+ Level string

+ MagusVersion string

+ Project string

+ Ref string

+ Status string

+ Stream string

+ Target string

+ Text string

+ Ts int64

+ type Invocation struct

+ Command Command

+ FinishedMs int64

+ ID string

+ MagusVersion string

+ StartedMs int64

+ Status string

type Magus

+ func (m *Magus) BranchChanges(ctx context.Context, limit int) ([]types.BranchChange, error)

+ func (m *Magus) ClassifyFiles(ctx context.Context, paths []string) ([]types.FileEntry, error)

+ func (m *Magus) ComputeTargetKey(ctx context.Context, projectPath, target string, charms []string) (key string, lines []string, err error)

+ func (m *Magus) ContextWithSecrets(ctx context.Context) context.Context

+ func (m *Magus) CurrentRevision(ctx context.Context) (name, revision string, dirty bool)

+ func (m *Magus) Diff(ctx context.Context, paths []string) (types.Diff, error)

+ func (m *Magus) DiffTUIEnabled() bool

+ func (m *Magus) EvaluateProjects(ctx context.Context) (types.EvaluatedProjectsOutput, error)

+ func (m *Magus) EvaluateTarget(ctx context.Context, t types.Target) ([]types.EvaluatedTarget, error)

+ func (m *Magus) FileAt(ctx context.Context, rev, path string) (string, error)

+ func (m *Magus) FindOutputProducer(absPath string) *types.Project

+ func (m *Magus) GetArtifact(ctx context.Context, v cache.ArtifactVersion, dst string) error

+ func (m *Magus) HeldLocks() []types.StatusLock

+ func (m *Magus) IdentifyRef(ctx context.Context, ref string) ([]types.RefMatch, error)

+ func (m *Magus) InvocationEventsByID(inv string) (Invocation, []Event, error)

+ func (m *Magus) LastRecordedRun(projectPath, target string) (cache.RecordedRun, error)

+ func (m *Magus) ListArtifacts(ctx context.Context, projectPath, wsPath string) ([]cache.ArtifactVersion, error)

+ func (m *Magus) ListCharms(ctx context.Context) ([]types.Charm, error)

+ func (m *Magus) ListProjects(ctx context.Context) (types.ProjectsOutput, error)

+ func (m *Magus) ListTargets(ctx context.Context) ([]types.TargetEntry, error)

+ func (m *Magus) LogBase(ctx context.Context, base, vcs string)

+ func (m *Magus) LogCache(ctx context.Context)

+ func (m *Magus) OutputAttempts(ref string) ([]OutputDescriptor, error)

+ func (m *Magus) OutputByRefRemote(ctx context.Context, ref string) ([]byte, OutputDescriptor, error)

+ func (m *Magus) OutputDescriptorByRef(ref string) (OutputDescriptor, error)

+ func (m *Magus) OutputKeyInputs(ref string) ([]string, error)

+ func (m *Magus) ProjectTargets(ctx context.Context, project string) []string

+ func (m *Magus) PublishOutput(ctx context.Context, ref string) (string, error)

+ func (m *Magus) RangeDiff(ctx context.Context, base, head string, paths []string) (string, error)

+ func (m *Magus) RefMatchCommand(mt types.RefMatch) string

+ func (m *Magus) ResolveTargetOutputs(ctx context.Context, projects []*types.Project, target string) ([]TargetArtifact, error)

+ func (m *Magus) ReviewOrigin(ctx context.Context) types.ReviewOrigin

+ func (m *Magus) RevisionCheckpoint(ctx context.Context, rev string) (types.VCSCheckpoint, error)

+ func (m *Magus) SecretProvider() string

+ func (m *Magus) SymbolGaps(ctx context.Context) ([]types.KnowledgeSymbolGap, bool)

+ func (m *Magus) SymbolOccurrences(ctx context.Context, key string) (SymbolOccurrenceRead, bool)

+ func (m *Magus) TargetGraph(ctx context.Context) (types.TargetGraphOutput, error)

+ func (m *Magus) Unreferenced(ctx context.Context) (types.UnreferencedOutput, error)

+ func (m *Magus) WorkingDiff(ctx context.Context, paths []string) (string, error)

+ func (m *Magus) Workspace(ctx context.Context, cfg types.WorkspaceConfig) (types.WorkspaceEntry, error)

+ type MetricsCollector struct

+ func (c *MetricsCollector) Collect(ctx context.Context) (metricdata.ResourceMetrics, error)

type Option

+ func WithVersion(v string) Option

+ func WithoutWorkspaceProviders() Option

+ type OutputDescriptor struct

+ Attempt string

+ Dirty bool

+ DurationMs int64

+ ErrMsg string

+ ExtraArgs []string

+ Failed bool

+ Inv string

+ Key string

+ KeyVersion int

+ MagusVersion string

+ Platform string

+ Project string

+ Ref string

+ Revision string

+ Spell string

+ Target string

+ TimestampMs int64

+ VCSName string

type PlanOptions

+ BaseRef string

+ ChangedPaths []string

+ type SymbolOccurrenceRead struct

+ Files []types.SymbolOccurrenceFile

+ Names []string

+ Unreadable []types.KnowledgeSymbolGap

+ func SymbolOccurrences(ctx context.Context, ws types.Inspector, root string, cfg config.Config, ...) (read SymbolOccurrenceRead, ok bool)

+ type TargetArtifact struct

+ Glob string

+ Path string

+ ProjectPath string

type TargetOption

+ func Drift(policy types.DriftPolicy, reason string) TargetOption

+ func IncludeArch(v bool) TargetOption

+ func IncludeOS(v bool) TargetOption

v0.3.0

Jul 25, 2026

v0.2.1

Jul 19, 2026

v0.2.0

Jul 18, 2026

Changes in this version

+ func BuildGlobalKnowledgeGraph(ctx context.Context, ws types.WorkspaceRepository, cfg config.Config, ...) (*knowledge.Graph, error)

+ func BuildKnowledgeGraph(ctx context.Context, ws types.Describer, root string, cfg config.Config, ...) (*knowledge.Graph, error)

+ func MergeWorkspaceSymbols(ctx context.Context, ws types.Describer, root string, cfg config.Config, ...) error

+ func MergeWorkspaceSymbolsForRef(ctx context.Context, ws types.Describer, root string, cfg config.Config, ...) error

+ type Daemon interface

+ Serve func(ctx context.Context) error

type Magus

+ func (m *Magus) BeginInvocation(ctx context.Context, cmd journal.Command, magusVersion string, ...) (context.Context, func(error))

+ func (m *Magus) CacheDir() string

+ func (m *Magus) CacheDiskBytes() int64

+ func (m *Magus) CacheStats() cache.Stats

+ func (m *Magus) DescribeCharms(defaults []string) types.CharmsOutput

+ func (m *Magus) DescribeFiles(paths []string) types.FilesOutput

+ func (m *Magus) InvocationByID(inv string) (journal.Invocation, error)

+ func (m *Magus) KnowledgeGraph(ctx context.Context, refresh bool) (*knowledge.Graph, error)

+ func (m *Magus) KnowledgeGraphHealthy() (watching, valid bool)

+ func (m *Magus) KnowledgeGraphWithSymbols(ctx context.Context) (*knowledge.Graph, error)

+ func (m *Magus) KnowledgeGraphWithSymbolsForRef(ctx context.Context, ref string) (*knowledge.Graph, error)

+ func (m *Magus) LogCharms(charms string)

+ func (m *Magus) MetricsCollector() (*otlp.Collector, bool)

+ func (m *Magus) MetricsSnapshot(ctx context.Context) ([]byte, error)

+ func (m *Magus) OutputByRef(ref string) ([]byte, cache.OutputDescriptor, error)

+ func (m *Magus) ReindexSymbols(ctx context.Context) (int, error)

+ func (m *Magus) ServeDaemon(ctx context.Context) error

+ func (m *Magus) SetDaemon(d Daemon)

+ func (m *Magus) SymbolIndexStatus(ctx context.Context) []types.SymbolIndexStatus

+ func (m *Magus) Telemetry() observability.Provider

+ func (m *Magus) Volatility(ctx context.Context) (types.VolatilityReport, error)

+ func (m *Magus) WatchKnowledgeGraph(ctx context.Context) (func(), error)

+ func (m *Magus) WatchSymbolIndexing(ctx context.Context) (func(), error)

type Option

+ func WithMetricsCollection() Option

+ func WithProvider(p observability.Provider) Option

type RunOption

+ func WithNoCache() RunOption

+ func WithNoVolatilityRetry() RunOption

type TargetOption

+ func RetryOnVolatile() TargetOption

v0.1.0

Jul 6, 2026

Changes in this version

+ const StreamAllSentinel

+ func ApplyUnionSandbox(ctx context.Context, roots []string) error

+ func ComposeGraph(ws types.WorkspaceRepository, opts ...ComposeOption) types.GraphOutput

+ func DefaultConcurrency() int

+ func FindRoot(dir string) (string, error)

+ func IgnoreGlob(pattern string) types.IgnorePattern

+ func IgnoreLiteral(pattern string) types.IgnorePattern

+ func IgnoreRegex(pattern string) types.IgnorePattern

+ func Inspect(ctx context.Context, root string, opts ...Option) (types.WorkspaceRepository, error)

+ func TargetLabel(targets []types.Target, source string) string

+ func WithWorkspaceRegistryContext(ctx context.Context, reg *WorkspaceRegistry) context.Context

+ type BindingOption = workspace.BindingOption

+ func WithClaim(globs ...string) BindingOption

+ func WithClaimWeight(weight int) BindingOption

+ func WithoutClaim(globs ...string) BindingOption

+ type ComposeOption func(*compose)

+ func WithComposeRoots(paths ...string) ComposeOption

+ func WithComposeSpell(name string) ComposeOption

+ func WithGraphHistory(h *forecast.History, target string) ComposeOption

+ func WithGraphInput(g *types.Graph) ComposeOption

+ func WithUpstream() ComposeOption

+ type Limiter struct

+ func NewLimiter(n int) *Limiter

+ func (l *Limiter) Capacity() int

+ type Magus struct

+ func Open(ctx context.Context, root string, opts ...Option) (*Magus, error)

+ func (*Magus) DescribeSpells() types.SpellsOutput

+ func (m *Magus) Affected(ctx context.Context, base string) (*types.AffectedResult, error)

+ func (m *Magus) AffectedFromPaths(ctx context.Context, paths []string) (*types.AffectedResult, error)

+ func (m *Magus) Affinity(ctx context.Context, opts types.InsightOptions) (types.AffinityOutput, error)

+ func (m *Magus) All() []*types.Project

+ func (m *Magus) CleanCache(ctx context.Context, projects ...*types.Project) error

+ func (m *Magus) CleanOutputs(ctx context.Context, projects []*types.Project, dryRun bool) ([]string, error)

+ func (m *Magus) Close() error

+ func (m *Magus) DescribeEvaluatedProjects() types.EvaluatedProjectsOutput

+ func (m *Magus) DescribeGraph() types.TargetGraphOutput

+ func (m *Magus) DescribeProjects() types.ProjectsOutput

+ func (m *Magus) DescribeTarget(t types.Target) (types.EvaluatedTargetsOutput, error)

+ func (m *Magus) DescribeTargets() types.TargetsOutput

+ func (m *Magus) DescribeWorkspaces(cfg types.WorkspaceConfig) types.WorkspacesOutput

+ func (m *Magus) ExpandAffected(ctx context.Context, target string, baseRef string) (targets []types.Target, source string, fellBack bool, err error)

+ func (m *Magus) ExpandCwd(t types.Target) (targets []types.Target, found bool, err error)

+ func (m *Magus) ExpandPath(t types.Target) ([]types.Target, error)

+ func (m *Magus) ExportCache(ctx context.Context, w io.Writer) error

+ func (m *Magus) FindOutputOwner(absPath string) *types.Project

+ func (m *Magus) Get(path string) *types.Project

+ func (m *Magus) Graph() (*types.Graph, error)

+ func (m *Magus) Hotspots(ctx context.Context, opts types.InsightOptions) (types.HotspotOutput, error)

+ func (m *Magus) ImportCache(ctx context.Context, r io.Reader) error

+ func (m *Magus) LogScope(label, source string)

+ func (m *Magus) Ownership(ctx context.Context, opts types.InsightOptions) (types.OwnershipOutput, error)

+ func (m *Magus) Plan(ctx context.Context, target string, opts PlanOptions) (types.ShardPlan, error)

+ func (m *Magus) PruneCache(ctx context.Context, cutoff time.Time, dryRun bool) (removed int, freed int64, err error)

+ func (m *Magus) PruneRemoteCache(ctx context.Context, olderThan time.Duration, keepLast int, dryRun bool) error

+ func (m *Magus) ResolveProjects(targets []types.Target) []*types.Project

+ func (m *Magus) Root() string

+ func (m *Magus) Run(ctx context.Context, targets []types.Target, opts ...RunOption) error

+ func (m *Magus) RunAffected(ctx context.Context, target string, opts ...RunOption) error

+ func (m *Magus) RunCI(ctx context.Context, targets []types.Target, opts ...RunOption) error

+ func (m *Magus) SetGraphObserver(o types.Observer)

+ func (m *Magus) Stream(ctx context.Context, r io.Reader, target string, errFn func(error), ...) error

+ func (m *Magus) TailLog(projectPath, target string) (logPath string, err error)

+ func (m *Magus) Trend(ctx context.Context, opts types.InsightOptions) (types.TrendOutput, error)

+ func (m *Magus) VCSOptions() types.VCSOptions

+ func (m *Magus) Where(dir string) (*types.Project, bool)

+ type Option = workspace.Option

+ func WithConfigFile(path string) Option

+ func WithLimiter(l *Limiter) Option

+ func WithLoadedConfig(cfg config.Config) Option

+ func WithWorkspaceRegistry(reg *WorkspaceRegistry) Option

+ type PlanOptions struct

+ HistoryPath string

+ MaxShards int

+ RunnerPoolBudget int

+ type ProjectOption = workspace.ProjectOption

+ func WithDependsOn(paths ...string) ProjectOption

+ func WithExclusive() ProjectOption

+ func WithOutputs(paths ...string) ProjectOption

+ func WithSpell(name string, opts ...BindingOption) ProjectOption

+ func WithTarget(name string, opts ...TargetOption) ProjectOption

+ func WithWatchIgnore(patterns ...types.IgnorePattern) ProjectOption

+ type ReportWriter struct

+ func NewReportWriter(dst io.Writer, filter []string) (*ReportWriter, error)

+ func (rw *ReportWriter) Close() error

+ func (rw *ReportWriter) GraphObserver() types.Observer

+ func (rw *ReportWriter) RecordShardTotal(shardID string, nShards int, duration time.Duration) error

+ type RunOption func(*run)

+ func WithBaseRef(ref string) RunOption

+ func WithCharms(charms ...string) RunOption

+ func WithDryRun() RunOption

+ func WithExtraArgs(args []string) RunOption

+ func WithNoFlakeRetry() RunOption

+ func WithRace() RunOption

+ func WithRaceReplay() RunOption

+ func WithReport(rw *ReportWriter) RunOption

+ func WithReportWriter(w io.Writer) RunOption

+ func WithSpellFilter(name string) RunOption

+ func WithStep() RunOption

+ func WithTargetNameNormalizer(n types.TargetNameNormalizer) RunOption

+ func WithWrite() RunOption

+ type StreamOption func(*streamOpts)

+ func WithStreamDryRun() StreamOption

+ func WithStreamExtraArgs(args []string) StreamOption

+ func WithStreamNull() StreamOption

+ type TargetHandler func(context.Context, *types.Project) error

+ type TargetOption = workspace.TargetOption

+ func Exclusive() TargetOption

+ func FailOnDrift() TargetOption

+ func RetryOnFlake() TargetOption

+ type WorkspaceRegistry = workspace.WorkspaceRegistry

+ func NewWorkspaceRegistry() *WorkspaceRegistry

+ func WorkspaceRegistryFromContext(ctx context.Context) *WorkspaceRegistry

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