magus v0.3.0 is out. See what's new
¶ View markdown source · ✎ Suggest an edit
1 min read

magus-doctor

Validate the workspace

Synopsis

magus doctor [flags]

Description

Run a suite of diagnostic checks against the workspace and report the results. Checks include:

  • Project discoverability and language coverage
    • A defined ci target and clean magusfile syntax
    • Dependency graph cycles
    • Workspace-escaping symlinks
    • Recognized MAGUS_* environment variables (typo detection)
    • Charm/target name collisions
    • Consistent target naming convention (any casing, but pick one)
    • VCS base-ref reachability

Findings come at two levels. [fail] is a workspace that is wrong regardless of how you like to work - a dependency graph cycle, an unparsable magusfile, two targets claiming one output - and exits non-zero. [advice] is a convention magus recommends, such as target naming or language coverage; it is reported and exits zero, because ci is the one target name magus reserves and the rest of the layout is yours. No flag promotes advice to failure.

Examples

Run all checks

magus doctor

JSON report

magus doctor -o json

See Also

magus(1), magus-ls(1), magus-describe(1), magus-run(1), magus-x(1), magus-where(1), magus-affected(1), magus-insight(1), magus-graph(1), magus-watch(1), magus-status(1), magus-config(1), magus-server(1), magus-completion(1), magus-man(1), magus-init(1), magus-self(1), magus-version(1)

ManpagePages in this section. magus stdlibReference for every magus stdlib module - fs, os, http, json, yaml, crypto, and the rest of the magusfile API surface. magus-queryQuery the magus knowledge graph to find and relate entities (projects, targets, spells, ops, charms, modules, diagnostics, docs). magus describeDefine a magus concept (spell, charm, target, project, workspace, module, mcp-tool) and list every entity of that kind, or detail one when a name is given.
auto-generatedclimagus doctordiagnosticstroubleshootingvalidationworkspace
Last updated (6e087567)
Earlier changes on this page (5)

Full history ↗ · Blame source ↗

Glossary

Workspace

The magus root directory that owns a set of projects and shared config; the unit magus operates over. See workspace.

Project

A directory magus recognizes as a unit of work (it has a magusfile); the unit of caching, scheduling, and dependency tracking. See workspace.

Magusfile

The magusfile.buzz that declares a project's targets (as export funs) and binds its spells. See targets.

Target

A named operation (build, test, ...) you invoke with magus run <target>; it may compose a spell's tool-native operations and depend on other targets. See targets.

Charm

An execution modifier attached with : (lint:rw) that changes how a target runs, not which one; the built-in rw flips a check-only target to mutate in place, and ci always strips it. See charms.

Affected

The set of projects touched by a change; magus affected <target> runs a target only over them. See affected.

CI

An ordinary magusfile-defined target you compose yourself with magus\needs - magus does not hardcode its stages. Magus.RunCI treats it specially only in that it strips the rw charm, it is the anchor magus affected ci keys off, and a selected scope with no project declaring it is a load error rather than a silent no-op. See targets.

MAGUS.md

The committed routing index at a workspace root, regenerated from the knowledge graph: it lists every node and points at the exact query for a given question, so it is the entry point an agent reads first. See knowledge.

Insight

The reports magus derives over the graph and history (hotspots, affinity, ownership, trend). See insight.

Conventions

This page uses none of the site's convention markers. The full set is on the conventions page.