Skip to content

README is missing several documented CLI options (--head/--tail, --emoji, --rst, --inspect, --max-width, --panel-style, --title/--caption, --export-svg, --version) #136

Description

@philipgadsden3

Running rich --help shows a number of options that aren't documented anywhere in the README:

  • -h/--head and -t/--tail — display first/last N lines (requires --syntax or --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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions