Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

CLI format flag over 'pretty' option

Open
  • Is something wrong?
#1,144 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
38/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
api, cli

Research direction

Start by locating the Python CLI entry point and the code that formats JSON output for commands. Add an optional pretty-print argument covering all APIs, then verify that each CLI command writes indented JSON to stdout while retaining the existing default behavior.

Written by the indexing model from the issue text.

Description

Problem
The CLI does not currently support pretty printing JSON outputs from commands. This is annoying because JSON can be difficult to read when it's not pretty printed, and users will need to pipe CLI outputs to custom bash commands to pretty print their JSON. Supporting pretty print as an optional argument in the CLI will be a better UX.

Solution
Enhance the CLI with an optional argument to pretty print JSON outputs to stdout.

A/C

  • CLI supports a new optional argument to pretty print JSON outputs to stdout for all APIs.
Dominant language
Python
Stars
300
Forks
99
Avg merge
9d 22h
Merged PRs (30d)
3

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from planetlabs/planet-client-python

All issues in planetlabs/planet-client-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.