Skip to content

Improve general human-readable CLI output #1060

Open

Description

@ChristianPavilonis

Description

Improve the human-readable output of the ts CLI so operators can identify what a command did, which resource it affected, and what action an error requires. The current CLI has a small shared output module (crates/trusted-server-cli/src/output.rs) that prints plain informational and warning lines; the issue does not identify particular commands or messages that fail in practice. Begin with an inventory of representative command output before choosing formatting changes.

Proposed scope

  • Identify the commands and concrete messages that are hard to scan or act on; capture before/after examples in the change.
  • Establish consistent wording and visual hierarchy for status, warnings, errors, identifiers and follow-up steps. Use color only when the terminal supports it, and preserve readable output when color is unavailable or disabled.
  • Keep machine-readable output, especially documented JSON fields and exit semantics, stable. Avoid adding terminal escape sequences to redirected output or JSON.

Done when

  • The change names the affected commands and includes before/after output examples for normal and error paths.
  • Human-readable output is clear in interactive, redirected and no-color contexts.
  • Existing JSON output and exit behavior are unchanged, with focused regression coverage for any shared formatter changes.

Affected area

CLI output and documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions