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

magus-completion

Print a shell completion script

Synopsis

magus completion <bash|zsh|fish|powershell>

Description

Print a shell completion script to stdout. Every script registers both magus and the mgs shorthand.

Completes subcommands, the targets accepted by run and affected, the nouns accepted by describe, and each subcommand's flags. Project paths are completed live by shelling out to magus ls -o name, so they track the workspace instead of a baked-in list; outside a workspace they are simply empty.

Install differs per shell, and zsh is the one that bites:

bash source it from ~/.bashrc, which re-reads it from the binary on every new shell and so survives an upgrade: source <(magus completion bash) zsh write it to a directory on $fpath as _magus. The script ends by invoking its own completion function, so sourcing it from ~/.zshrc runs that outside a completion context and registers nothing. Regenerate the file after magus self update. fish write it to ~/.config/fish/completions/magus.fish, loaded on demand. powershell append it to $PROFILE. pwsh is accepted as an alias, for the cross-platform PowerShell binary's own name.

Examples

Bash: source from the rc, never goes stale

echo 'source <(magus completion bash)' >> ~/.bashrc

Zsh: install onto $fpath (not into ~/.zshrc)

magus completion zsh > ~/.zsh/completions/_magus

Fish

magus completion fish > ~/.config/fish/completions/magus.fish

PowerShell

magus completion powershell >> $PROFILE

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-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-man(1), magus-init(1), magus-spell(1), magus-agent(1), magus-self(1), magus-version(1)

ManpagePages in this section. magus affectedRun a target for every project affected by a VCS diff, with forensic modes for explain, graph, CI shard plan, and regression bisect. magus configInspect the effective merged configuration or write keys to the local or global magus.yaml, with subcommands for view, set, history, cache, and mcp. magus describeDefine a magus concept (spell, charm, target, project, workspace, module, mcp-tool, tool, file, graph) and list every entity of that kind, or detail one when a name is given.
generatedinternal/cli/registry.goclimagus completioncompletionbashzshfishpowershellshell
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.

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.