Skip to content

CLI‑friendly

rhoopr edited this page May 26, 2026 · 2 revisions

--friendly

Force the friendly terminal UI on for one invocation.

Usage

kei sync --friendly

Details

  • Default: auto on plain TTYs
  • Type: boolean flag
  • TOML key: [ui].friendly
  • Mutually exclusive with --no-friendly; the last flag wins

Friendly mode shows the curated progress UI: phase narration, progress card, retry wording, and end-of-run summary. It is normally on only for an interactive terminal.

Hard-off contexts still win over --friendly:

  • stdout or stderr is not a TTY
  • --only-print-filenames or --no-progress-bar is set
  • kei service run is active
  • Docker or systemd is detected
  • TERM=dumb
  • --log-level was passed or RUST_LOG is set

Persist the preference in TOML:

[ui]
friendly = true

Resolution chain: CLI, then TOML, then auto-detected default.

Related

Commands

Getting Started

Features

Clone this wiki locally