Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Invocation

mtui ships two binaries. mtui is the interactive REPL; mtui-mcp is the MCP server. Both read the same configuration and accept overrides on the command line.

mtui is REPL-only. There is no positional single-command mode: mtui always starts the interactive shell (optionally seeding it with -a/-k/-s). Headless, one-shot command dispatch is served by mtui-mcp, not by a CLI flag.

mtui

Maintenance Test Update Installer

Usage: mtui [OPTIONS]

Options:
  -t, --template-dir <DIR>
          Override config `mtui.template_dir`

  -s, --sut <HOSTS>
          Cumulatively override the default hosts from the template (format: `hostname,hostname2`). May be given more than once

  -w, --connection-timeout <SECONDS>
          Override config `mtui.connection_timeout` (seconds)

      --reboot-timeout <SECONDS>
          Override config `connection.reboot_timeout`: the backoff base (seconds) for post-reboot reconnect retries

      --reboot-retries <COUNT>
          Override config `connection.reboot_retries`: the number of post-reboot reconnect attempts beyond the first probe

  -d, --debug
          Enable debugging output

  -c, --config <FILE>
          Override the default config path

      --color <COLOR>
          Control coloured output

          Possible values:
          - auto:   Colour iff stderr is a TTY and `NO_COLOR` is unset. The default
          - always: Always emit colour escapes
          - never:  Never emit colour escapes
          
          [default: auto]

  -g, --gitea-token <TOKEN>
          Gitea access token

      --ssl-verify <BOOL|PATH>
          Override config `mtui.ssl_verify`: TLS certificate verification for all outbound HTTP. Accepts `true`/`false` (and the spellings `yes`/`no`/ `on`/`off`/`1`/`0`), or a path to a custom CA bundle/certificate

  -a, --auto-review-id <RequestReviewID>
          OBS request review id, run under the automatic workflow (example: `SUSE:Maintenance:1:1`)

  -k, --kernel-review-id <RequestReviewID>
          OBS kernel/live-patch request review id, run under the kernel workflow (example: `SUSE:Maintenance:1:1`)

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

Loading an update at start with -a/-k connects its reference hosts and, under the automatic workflow, downloads openQA install logs — the same as running load_template in the REPL. -s/--sut overrides the hosts drawn from the template.

mtui-mcp

MCP server for mtui (tools synthesised from the command registry)

Usage: mtui-mcp [OPTIONS]

Options:
  -t, --template-dir <DIR>
          Override config `mtui.template_dir`

  -w, --connection-timeout <SECONDS>
          Override config `mtui.connection_timeout` (seconds)

  -d, --debug
          Enable debugging output

  -c, --config <FILE>
          Override the default config path

      --color <COLOR>
          Control coloured (log) output. Logs go to stderr; stdout is the transport

          Possible values:
          - auto:   Colour iff stderr is a TTY and `NO_COLOR` is unset. The default
          - always: Always emit colour escapes
          - never:  Never emit colour escapes
          
          [default: auto]

  -g, --gitea-token <TOKEN>
          Gitea access token

      --ssl-verify <BOOL|PATH>
          Override config `mtui.ssl_verify`: TLS certificate verification for all outbound HTTP. Accepts `true`/`false` (and the spellings `yes`/`no`/ `on`/`off`/`1`/`0`), or a path to a custom CA bundle/certificate

      --transport <TRANSPORT>
          MCP transport to serve on: `stdio` (default, one client) or `http` (streamable HTTP, per-client session isolation)

          Possible values:
          - stdio: Serve over stdin/stdout (default). One process serves one client
          - http:  Serve over streamable HTTP. One process serves many isolated clients
          
          [default: stdio]

      --host <ADDR>
          Bind address for `--transport http` (default: 127.0.0.1). Ignored under stdio. Loopback only — rmcp's DNS-rebinding guard rejects non-loopback hosts
          
          [default: 127.0.0.1]

      --port <PORT>
          Bind port for `--transport http` (default: 8000). Ignored under stdio
          
          [default: 8000]

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

mtui-mcp takes no boot-time update/host flags (-a/-k/-s are mtui only): each MCP client loads its own state at runtime via the load_template and add_host tools. See MCP server.