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

magus-watch

Emit changed file paths to stdout

Synopsis

magus watch [flags]

Description

Watch the workspace for file-system changes and emit batches of changed repo-relative paths to stdout. Each path is on its own line; a blank line separates batches. This output format is compatible with git diff --name-only so the two are interchangeable on either side of a pipe.

Use --null for binary-safe output: paths are NUL-separated and batches end with a double-NUL, matching the --null flag of magus affected --stdin.

On startup an --all sentinel batch is emitted (unless --initial=false) to trigger a full initial build in the downstream magus affected --stdin.

Options

--backend string (default: fsnotify)
Notification backend: fsnotify, poll, or auto (probes fsnotify, falls back to poll)
--debounce duration (default: 200ms)
Quiet window before emitting a batch
--ignore string
Ignore pattern; repeatable. Form: type=<glob|regex|literal>,pattern=<value>
--initial (default: true)
Emit an --all batch on startup before watching
--null
NUL-separate paths; double-NUL between batches

Examples

Continuous build pipeline

magus watch | magus affected --stdin build

Increase debounce for slow editors

magus watch --debounce 500ms | magus affected --stdin test

Polling backend (when inotify is unavailable)

magus watch --backend poll | magus affected --stdin build

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-events(1), magus-status(1), magus-clean(1), magus-shell(1), magus-vcs(1), magus-queue(1), magus-doctor(1), magus-config(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)

generatedinternal/cli/registry.goclimagus watchwatchfilesystemfsnotifycontinuous build
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.

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.

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.

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.

Window

The terminal a command runs in. It keys fire-once notices for a caller no host gave a session, and is never recorded as a session.

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.