Adding JSON output to a CLI app
An article suggesting best practices for adding JSON output to CLI apps, and mentioning why JSON output is a good idea.
- Do Make a Schema
- Do Flatten the Structure
- Do Output JSON Lines for Streaming Output
- Do Use Predictable Key Names
- Do Pretty Print with Two Spaces or Don’t Format at All
- Don’t Use Special Characters in Key Names
- Don’t Allow Duplicate Keys
- Don’t Use Very Large Numbers