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

podman

The podman spell forks the podman CLI. It is separate from docker rather than a bin substitution because podman has no buildx: multi-platform images are podman build --platform plus podman manifest, so the two runtimes need different ops rather than the same ops with a different binary.

Runtime name: podman (source spells/podman/)

Version probe (podman): podman --version

Passing arguments to ops

Every op is invoked as podman["<op>"](ctx, opts?). The first argument is the target's context, which is what carries the execution environment; the optional options map shapes the command itself:

Key Type Description Source
args [str] Extra arguments appended to the resolved command, replacing any trailing defaults the op declares (go-test's ./...), so passing args also states the scope. Omit it and a bare podman["<op>"]() keeps the defaults and forwards magus run <target> -- <extra> to the tool automatically; pass it to set the arguments explicitly, which replaces that passthrough. source
stdin str Data written to the command's standard input. source

Working directory and environment are NOT options: they ride the context, as podman["<op>"](ctx.withCwd("sub")) and podman["<op>"](ctx.withEnv({"CGO_ENABLED": "0"})). Only the context reaches the cache key, so an option-table cwd or env would change what the tool did while the key said otherwise; passing either as an option is an error.

Charms (the :charm suffix, e.g. magus run test:rw) are orthogonal: they patch the base argv, while these options add to it. See Charms.

podman-build

Command: podman build

podman-manifest

Multi-platform images without buildx: build per-arch, then assemble and push a manifest list. The caller supplies the list name and members through args.

Command: podman manifest

podman-push

podman push is its own verb; docker reaches the same place through buildx --push.

Command: podman push

podman-run

--rm is baked in for the same reason the docker spell bakes it in: an op that leaves containers behind turns a repeated target into a disk leak.

Command: podman run --rm

SpellsA spell is a library of tool-native ops (go-build, cargo-clippy, eslint) plus cache metadata that your magusfile composes into runnable targets. docker spellDocker spell: image build, build-check, buildx, and hadolint Dockerfile linting. bash spellBash spell: shellcheck linting for shell scripts. buf spellBuf spell: protobuf build, lint, format, and code generation.
generatedspells/podman/spell.buzzpodmanspellcontainerimageocibuildahtools
Last updated (16372805)
Earlier changes on this page (4)

Full history ↗ · Blame source ↗

Glossary

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.

Charm

An execution modifier attached with : (lint:rw) that changes how a target runs, not which one; the built-in rw flips a check-only target to mutate in place, and ci always strips it. See charms.

Ward

A coded diagnostic that inspects a resolved op and nudges or blocks an anti-pattern before it runs. See wards.

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.

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.

Conventions

Placeholders

Angle brackets mark a value you replace with your own - never type the brackets:

magus run <target>
magus completion <shell>    # e.g. bash, zsh, fish

<target>, <path>, <shell>, <name> and the like are stand-ins, not literal text.