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

magus-self

Manage the magus binary (update, refresh, registry, install-shorthand)

Synopsis

magus self <subcommand> [flags]

Description

Targets for managing the magus binary.

update is compiled in by default. Package maintainers who own the system binary can build with -tags noselfupdate to disable the self-update mechanism. refresh, registry, and install-shorthand are available in every build.

To bootstrap a workspace, use: magus init

self update options

--bin-dir string
Install into this directory instead of replacing in place
--check
Print whether an update is available and exit without installing
--dry-run
Verify everything but do not replace the running binary
--force
Allow downgrades and re-installs of the current version
--version string
Install a specific release tag (e.g. v0.4.2)
-y
Short for --yes
--yes
Skip interactive confirmation

self install-shorthand options

--dir string
Directory for the shorthand (default: the running binary's directory)
--force
Replace an existing file at the shorthand path

Subcommands

update
Update magus to the latest release
refresh
Fetch, verify, and cache the registry (a data file; does not upgrade magus)
registry
What is cached, how old, and from where
install-shorthand
Symlink mgs, the magus shorthand, to the running binary

Examples

Update the running binary

magus self update

Refresh the registry data

magus self refresh

Show cached registry state

magus self registry

Install the mgs shorthand

magus self install-shorthand

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-vcs(1), magus-doctor(1), magus-config(1), magus-session(1), magus-memory(1), magus-notes(1), magus-diff(1), magus-server(1), magus-mcp(1), magus-buzz(1), magus-completion(1), magus-man(1), magus-init(1), magus-agent(1), magus-version(1)

ManpagePages in this section. magus-runRun builds, tests, lints, and codegen through magus targets. ChangelogEvery released change to magus, newest first, in Keep a Changelog format. Generated from releases/*.yaml. Cache modelHow magus computes a content-addressed cache key from a target's declared inputs, replays outputs on a hit without rerunning the body, and stores it all as plain files under .magus.
generatedinternal/cli/registry.goclimagus selfself updateself refreshself registryself install-shorthandupdatesversioninginstallmgs
Last updated (4f8cc295)
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.

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.

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.

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

One magus process's recorded facts - the targets it finished, their outcomes, and the lease it acted as - kept in a repo-scoped store every worktree shares. magus session lists them; the store prunes itself by last-fact age.

Lease

One row of the lease ledger: a piece of work an orchestrating agent handed out, with its goal, the checkpoint it was cut against, and the paths it owns or must not touch. The ledger records; the agent guard is what reads those facts back when grading a write. See doctrine.

Conventions

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