cli-guidelines-resources-03

Structure output using stdout for results and stderr for errors, with optional --json flag for machine-readable formats. This separation ensures scripts and tools can reliably parse program output while users see readable text.

Detect TTY availability to conditionally apply colors and paging; disable colored output when piping to files or other commands. This prevents formatting codes from corrupting data while preserving readability in interactive terminals.

Output valid JSON to stdout with consistent schema, enabling downstream tools to parse results programmatically. Include structured metadata alongside data so automation can handle errors and validate responses.

Use standardized exit codes (0 for success, non-zero for specific failures) so scripts can branch on program outcomes without parsing text output. This makes error handling predictable across different operating systems and shells.

Yes—use aligned tables for terminal display and JSON or CSV formats via flags for automation. Dual formats let users read results interactively while scripts extract data reliably.

Standardized help generation across tools reduces user friction and enables consistent documentation. Following conventions for flags, subcommands, and descriptions makes CLIs predictable and easier to integrate into workflows.