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

magus-config

View or update magus configuration

Synopsis

magus config <view|set|init> [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/.

Subcommands

view
Print the effective configuration (defaults + file + env)
set
Write a key to the local (or global) config file
init
Materialize built-in defaults to magus.yaml
cache
Manage the build cache (prune --older-than)

Examples

Show effective config

magus config view

Show config as JSON

magus config view -o json

Set cache to read-only

magus config set cache.immutable true

Initialize magus.yaml from defaults

magus config init

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-doctor(1), magus-server(1), magus-completion(1), magus-man(1), magus-init(1), magus-self(1), magus-version(1)

auto-generatedclimagus configconfigurationmagus.yamlsettingscache
Last updated (a170f9b2)
Earlier changes on this page (3)

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.

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.

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.