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

magus-affected

Run a target for VCS-diff affected projects

Synopsis

magus affected <target> [flags]

Description

Run a named target for every project that is affected by changes in version control. The active VCS adapter is picked by autodetect from .git, .hg, or .jj at the workspace root, or pinned with MAGUS_VCS_COMMAND_NAME / vcs.command_name. MAGUS_VCS_COMMAND overrides the command entirely. When MAGUS_VCS_ENABLED=false (or vcs.enabled: false) affected detection short-circuits and falls back to the full project set with the source label "vcs disabled".

A project is affected if any of its source files changed directly, or if a project it depends on is affected (transitive closure over the dependency graph).

Use --stdin to read changed paths from a pipe instead of running a VCS diff. This pairs with magus watch for continuous-build workflows:

magus watch | magus affected --stdin build

Forensic modes reason about the affected set instead of executing a target. --explain shows why a project is in the set. --plan emits a provider-neutral JSON shard plan for the named target. Combine --plan with --stdin for a one-shot plan of proposed paths before editing. --bisect drives VCS bisect using run history to find the commit that introduced a regression.

Options

--base string
Override base ref for the VCS diff (default: MAGUS_VCS_BASE_REF or per-VCS built-in)
--bisect string
Drive VCS bisect to find the commit that broke <project>
--depth int
With --graph: cap displayed depth (0 = unlimited)
--dry-run
Print what would run without executing
--explain string
Show why <project> is in the affected set instead of executing
--good string
With --bisect: known-good commit SHA (auto-detected from history when empty)
--graph
Render the dependency graph for the affected scope instead of executing
--max-parallel-budget int
With --plan: cross-shard concurrency cap; 0 = unlimited
--max-shards int (default: 8)
With --plan: maximum CI shards (-1 = unlimited)
--null
With --stdin: expect NUL-separated paths and double-NUL between batches
--plan
Emit a provider-neutral JSON CI shard plan for the affected set
--stdin
Read changed file paths from stdin instead of running a VCS diff
--target string (default: test)
With --bisect: magus target to bisect
--upstream
With --graph: show dependents instead of dependencies

Targets

ls
Print selected projects without executing anything
build
Build selected projects
test
Test selected projects
lint
Lint selected projects (read-only)
format
Format source files in selected projects
clean
Remove build artifacts from selected projects
generate
Run code generation for selected projects
ci
Run the magusfile's ci target read-only (affected-set anchor)

Examples

Build projects changed since the default base ref

magus affected build

Use a different base ref

magus affected build --base main

Pipe from watch for continuous builds

magus watch | magus affected --stdin build

List affected projects without building

magus affected list

Show dependency graph for the affected scope

magus affected build --graph

Graph as DOT for piping to Graphviz

magus affected build --graph -o dot | dot -Tsvg > graph.svg

Emit a CI shard plan for the affected set

magus affected ci --plan

Shard a test plan across at most four workers

magus affected test --plan --max-shards 4

Bisect a regression in myapp

magus affected --bisect ./apps/myapp

See Also

magus(1), magus-ls(1), magus-describe(1), magus-run(1), magus-x(1), magus-where(1), magus-insight(1), magus-graph(1), magus-watch(1), magus-status(1), magus-doctor(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. The CLI in practiceThe magus subcommands you actually reach for, grouped by the question you are asking, with the quirks that are not obvious from the help text. magus insightShow where a codebase's attention and risk concentrate: hotspots, temporal coupling, ownership, and trend from VCS history, plus volatility from run-outcome history. magus stdlibReference for every magus stdlib module - fs, os, http, json, yaml, crypto, and the rest of the magusfile API surface.
auto-generatedclimagus affectedaffectedchanged filesvcsgitbisectci
Last updated (38e9171e)
Earlier changes on this page (4)

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.

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.

Concurrency

How many targets run at once. It is bounded by the pool's capacity and set with --concurrency, MAGUS_CONCURRENCY, or the concurrency config key. See daemon.

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.