Skip to content

Docs accuracy: interactivity defaults and --human-friendly scope are overstated #703

@WadydX

Description

@WadydX

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:

  1. Clarify that interactivity is command-dependent; for init, TTY defaults to interactive and --non-interactive forces non-interactive mode.
  2. Replace "any command" wording with explicit command list that supports --human-friendly.
  3. 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions