Skip to main content Module cli Copy item path Source Args Command-line arguments. With no subcommand, muster launches its TUI. Probe One diagnostic line: what was probed, how it went, and the detail text. Report A command’s full output: a titled set of rows and an optional summary
shown only in the boxed layout. Row One line of command output: an optional labeled fact with a status kind. RunArgs muster run: register a command as a process in a project, then run it.CheckOutcome Result of validating a workspace config. CliError A failure while executing a CLI command. Command Subcommands. Absent, muster runs the TUI. CompletionShell Shells supported by the dynamic completion engine. HooksCommand User-facing lifecycle-integration commands. InternalHookCommand Commands invoked by installed provider integrations. ProbeOutcome Severity of a probe result. ProjectsCommand Registry management actions under muster projects. RowKind How a row is glyphed and colored in the boxed layout. The plain layout
shows glyphs only for labeled rows, preserving the pipeable line format. VALID_SUFFIX Suffix shared between muster check output and the doctor config probe. add Registers an existing folder that already contains a workspace file. any_failed Whether any probe failed (warnings do not fail the run). boxed The boxed layout: a rounded, titled frame around aligned rows, in the
TUI’s visual vocabulary. styled disables ANSI styling for tests. check Validates the workspace config at config_path. A config that fails to
parse or validate is a finding; a file that cannot be read at all is an
operational failure of the command itself. clipboard_probe Reports which clipboard path a copy would take. Informational only. completions_probe Best-effort check that the shell’s rc file registers completions; warns
with the exact line to add when it does not. config_probe Validates the workspace config. current_project_from_env Returns the current-project path exported into child panes, if present. doctor_report The report over all probes: one labeled row each, closed by a summary
counting outcomes (shown in the boxed layout only). error_chain Formats an error and its sources as one line, outermost first, separated by
": ". Reused by muster doctor to report multiple findings uniformly. hooks_probe Aggregates provider hook states into one line. hooks_probe_error A hooks probe for when the status scan itself failed. init Scaffolds a starter workspace in directory and registers it as a project.
Returns the report rows to print, in order. list Lists registered projects, marking the one containing current_dir. plain The plain layout: one unstyled line per row, matching the CLI’s original
output exactly. print Prints the report: the boxed styled layout on a terminal, the plain
line-per-fact layout when piped. anstream strips colors as needed. print_error Prints a failure to stderr in the CLI’s voice: a red cross, the app
name, and the error. anstream strips styling when stderr is redirected. registration The comment naming the destination file, then the hook line itself. registration_line The shell hook line enabling muster’s dynamic completions. registry_probe Reads the registry and flags projects whose config file is not a reachable
regular file - missing, a directory, or a dangling symlink all fail. remove Unregisters the named project; files on disk are untouched. resolve_tui_config Resolves an absolute workspace path for a bare TUI launch, preferring
explicit and contextual paths before local and globally registered ones. run Registers the command in the resolved project, then runs it in place. On
success this replaces the current process, so it does not return; any error
short-circuits before the command runs. sessions_probe Confirms the agent-session store is readable. summary_line Joins non-empty summary parts with the standard separator.