min commands

min helper commands are available within task sandboxes (Linux-only) and inside sessions, which install the same helper as /usr/bin/min.

Naming note: the in-sandbox min helper is a different tool from the min session CLI that happens to share its name. Inside a task sandbox, min always refers to the helper documented here; the session CLI is not available there.

Commands

add [FLAG] <PACKAGES...>

Installs tools & dependencies into the running sandbox. The default differs by sandbox type: in a session, min add <pkg> with no flag defaults to --session, installing the package live and recording it in the [session] packages list of the project’s minimal.toml; in a task sandbox, no flag installs for the current sandbox only and minimal.toml is not modified. With a flag, the named packages are recorded as a session, runtime, or build dependency in minimal.toml.

FlagDescription
--sessionAlso add packages to the [session] packages list in minimal.toml
--runtimeAlso add packages to stack.runtime_packages
--buildAlso add packages to stack.build_packages

min add is the in-sandbox counterpart of mip add; note the flag surfaces differ (mip add requires one of --runtime, --build, or --task <TASK>).

search <TERM>

Searches for and lists packages related to the search term.

check [<OPTIONS>] [FILTER_NAMES...]

Validates minimal configuration including packages, stacks, and profiles.

FlagDescription
--fixAttempt to fix any issues
--packagesCheck packages defined in the codebase
--stacksCheck stacks defined in the codebase
--profilesCheck profiles defined in the codebase

If no type flags are specified, all types are checked by default.

If filter names are specified, any package, stack, or profile matching a specified name is checked.

min check is the in-sandbox equivalent of the mip check command, with a reduced flag set (no --skip-checkers, and no short flag aliases).

run <TASK_NAME> [<ARGS>...]

Runs the specified task in a new Minimal sandbox. Interactive tasks are not supported.

min run is the in-sandbox equivalent of the mip run command.

package build <PACKAGES...>

Builds the named packages in a clean room, making them available in the local cache.

package patched-build <PACKAGE>

Builds the named package in a clean room using potentially-stale dependencies (the already-cached builds of its dependencies, without rebuilding them first), and commits the result to the local cache. Useful for quickly iterating on a single package’s build.

materialize [--arch <arch>] -o <out-file> <output-name>

Materializes an output specified in an [outputs.<name>] section of minimal.toml.

FlagShortDescription
--output <PATH>-o(required) The output file to write
--arch <ARCH>Override the architecture used when building the output (e.g. amd64, arm64); takes precedence over the arch field in minimal.toml and the host default