magus v0.4.3 is out. See what's new
¶ View generated markdown
2 min read

magus-config

View or update magus configuration

Synopsis

magus config <view|set|history|cache|mcp> [flags]

Description

Inspect or modify the magus configuration. Configuration is loaded in priority order: built-in defaults → user-global file → workspace file → project-local file → MAGUS_* environment variables → CLI flags.

The view sub-command prints the effective merged configuration. The set sub-command writes a key-value pair to the local (or global) config file. The init sub-command materializes the built-in defaults to a magus.yaml so they can be edited by hand.

Configuration is stored in magus.yaml (or .magus.yaml). The canonical locations are the workspace root and $XDG_CONFIG_HOME/magus/.

config set options

--global
Write to the global config ($XDG_CONFIG_HOME/magus/magus.yaml)

config history passed options

--commit string
Commit the run was at
--history string
Path to the history JSON to write (default: configured history_path)
--ref string
Ref the run was on (git branch, hg named branch, jj bookmark)
--status string (default: passed)
How the run came out: passed or failed
--target string (default: ci)
Target that ran

config history import options

--history string
Path to the history JSON to write (default: configured history_path)

config cache prune options

--dry-run
Print what would be removed without deleting anything
--keep-last int
Keep only the newest N entries, evict the rest (--remote only)
--older-than duration
Remove entries older than this duration (e.g. 168h = 7 days)
--remote
Prune the configured remote backend instead of the local cache

config cache export options

--to string
Write the archive to this file (default: stdout)

config mcp connector create options

--expires string
Lifetime: a duration like 90d or 48h, at most 366d (default 90d)
--name string
Name for this connector token (default: connector-N)

config token generate options

--force
Overwrite an existing token (rotation)

config console token create options

--code
Print a one-time code instead, for a console link's #code=; the console trades it for the token within a minute, once
--expires string
Lifetime: a duration like 90d or 48h, at most 366d (default 90d)
--name string
Name for this console token (default: console-N)
--viewer
Mint a READ-ONLY viewer token: it can read the console and cannot submit jobs, edit memory, or open a share

Subcommands

view
Print the effective configuration (defaults + file + env)
set
Write a key to the local (or global) config file
history
Manage forecaster runtime history
cache
Manage the build cache (prune)
mcp
Manage MCP connector tokens
token
Manage the operator token (every surface)
console
Manage the console (PWA) auth tokens

Examples

Show effective config

magus config view

Show config as JSON

magus config view -o json

Set cache to read-only

magus config set key=cache.immutable,value=true

Prune local cache entries older than a week

magus config cache prune --older-than 168h

See Also

magus(1), magus-ls(1), magus-describe(1), magus-run(1), magus-x(1), magus-where(1), magus-affected(1), magus-graph(1), magus-query(1), magus-explain(1), magus-path(1), magus-refs(1), magus-watch(1), magus-events(1), magus-status(1), magus-clean(1), magus-shell(1), magus-vcs(1), magus-queue(1), magus-doctor(1), magus-session(1), magus-memory(1), magus-job(1), magus-notes(1), magus-diff(1), magus-server(1), magus-broker(1), magus-mcp(1), magus-buzz(1), magus-completion(1), magus-man(1), magus-init(1), magus-spell(1), magus-agent(1), magus-self(1), magus-version(1)

ManpagePages in this section. magus graphEmit the project dependency DAG, export the knowledge graph for external graph tools, and report the graph's shape (god nodes, orphans, doc coverage). magus queryResolve search terms to knowledge-graph nodes and return the ranked matches plus their neighborhood; also retrieves a target's captured output by ref and a run's journal by invocation id. magus runRun a named target (build, test, lint, format, ci, etc.) for the selected projects, defaulting to the cwd project when no arguments are given.
generatedinternal/cli/registry.goclimagus configconfigurationmagus.yamlsettingscache
Last updated (00e25f0e)
Earlier changes on this page (7)

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.

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.

Op

A single tool-native command a target composes (long form: operation); the middle of the work hierarchy (Spell to Op to Target). See operations.

Spell

A language/runtime adapter (e.g. go, md) that maps generic targets onto a toolchain's real commands. See spells.

Buzz

The language magusfiles are written in (the .buzz engine). See engines.

Cache

The content-addressed store magus consults before running a target, so unchanged work is skipped. See cache.

Affected

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

Broker

The per-user background process that holds this host's capacity: the machine budget every run claims slots from, and the shared services runs keep warm. A run starts it on demand; broker: off in magus.yaml runs without one. See server.

Server

The background process a person starts with magus server start. It serves MCP, the console, background jobs and the warm knowledge graph, and adopts nested magus calls into one pool. See server.

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.

Session

An agent host's conversation, by the id the host delivers to its hooks. magus never mints one: a record with no session is unattributed, and the OS user it carries says whose account ran it.

Job

The unit of delegated work, and one row of the job store: what an orchestrating agent handed out, with its goal, the checkpoint it was cut against, the paths it may write or must not touch, and the one check it runs. A job's holder is either a session, for work an orchestrator handed out, or the server, for its own maintenance. The store records; the agent guard is what reads those facts back when grading a write. See doctrine.

A job is not a run. magus run build web is a run, and no job exists for it. A job causes runs: its check executes as one, and a server job records the invocation of its last one. Jobs are listed with magus ls jobs and in the console's Jobs view; runs are listed in the Runs view.

Run

One target executing under one magus invocation, such as magus run test web or magus affected ci. A run keeps its captured output behind an output reference. Every magus run is a run whether or not any job asked for it; see Job for how the two relate.

Conventions

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