README is missing several documented CLI options (--head/--tail, --emoji, --rst, --inspect, --max-width, --panel-style, --title/--caption, --export-svg, --version)
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- python
- Domain
- cli, documentation
Research direction
Start in the README's existing CLI options documentation and compare it with the output of rich --help from the reported rich-cli version. Add short descriptions and examples for the listed missing flags, including any stated requirements, and confirm that every option in the issue is represented in the README.
Written by the indexing model from the issue text.
Description
Running rich --help shows a number of options that aren't documented anywhere in the README:
-h/--headand-t/--tail— display first/last N lines (requires--syntaxor--csv)-j/--emoji— enable emoji codes--rst— render reStructuredText--syntax— explicit syntax-highlighting flag--inspect— inspect a Python object-W/--max-width-S/--panel-style(requires--panel)--title/--caption--export-svg-v/--version
The README documents most other flags (--style, --panel, --rule, etc.) with a short description and example, but these are missing entirely. Would be happy to submit a PR adding a short section for these if that's welcome.
Repro: pip install rich-cli && rich --help (v1.8.1)
- Dominant language
- Python
- Stars
- 3.7k
- Forks
- 117
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Textualize/rich-cli
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Textualize/rich-cli#19 · 4 comments · 4 reactions ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
Textualize/rich-cli#135 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
Textualize/rich-cli#132 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
Textualize/rich-cli#128 · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
Textualize/rich-cli#117 · 1 reaction ·
All issues in Textualize/rich-cli
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100