Problem
CLI documentation in docs/packages/cli.mdx currently states:
- "The CLI is non-interactive by default"
- "Add
--human-friendly to any command"
Current command behavior does not match both statements:
init is interactive on TTY unless --non-interactive is set
--human-friendly is command-specific (not global on every command)
This mismatch can mislead automation users and cause avoidable command failures.
Proposed solution
Update docs to match current behavior precisely:
- Clarify that interactivity is command-dependent; for
init, TTY defaults to interactive and --non-interactive forces non-interactive mode.
- Replace "any command" wording with explicit command list that supports
--human-friendly.
- Add one short compatibility note: prefer explicit mode flags in scripts/agents.
Alternatives considered
- Change code to make all commands non-interactive by default and add a global
--human-friendly switch.
That is broader and likely higher risk than a docs-accuracy fix.
Additional context
Source evidence:
docs/packages/cli.mdx (current wording)
packages/cli/src/commands/init.ts (interactive = !nonInteractive && process.stdout.isTTY === true)
packages/cli/src/commands/catalog.ts defines --human-friendly locally, indicating non-global scope.
Problem
CLI documentation in
docs/packages/cli.mdxcurrently states:--human-friendlyto any command"Current command behavior does not match both statements:
initis interactive on TTY unless--non-interactiveis set--human-friendlyis command-specific (not global on every command)This mismatch can mislead automation users and cause avoidable command failures.
Proposed solution
Update docs to match current behavior precisely:
init, TTY defaults to interactive and--non-interactiveforces non-interactive mode.--human-friendly.Alternatives considered
--human-friendlyswitch.That is broader and likely higher risk than a docs-accuracy fix.
Additional context
Source evidence:
docs/packages/cli.mdx(current wording)packages/cli/src/commands/init.ts(interactive = !nonInteractive && process.stdout.isTTY === true)packages/cli/src/commands/catalog.tsdefines--human-friendlylocally, indicating non-global scope.