Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add help sections #995

Merged
merged 5 commits into from
Apr 1, 2023
Merged

add help sections #995

merged 5 commits into from
Apr 1, 2023

Conversation

o2sh
Copy link
Owner

@o2sh o2sh commented Apr 1, 2023

Before:

Command-line Git information tool

Usage: onefetch [OPTIONS] [INPUT]

Arguments:
  [INPUT]  Run as if onefetch was started in <input> instead of the current working directory

Options:
      --ascii-input <STRING>
          Takes a non-empty STRING as input to replace the ASCII logo
  -a, --ascii-language <LANGUAGE>
          Which LANGUAGE's ascii art to print
  -c, --ascii-colors <X>...
          Colors (X X X...) to print the ascii art
  -d, --disabled-fields <FIELD>...
          Allows you to disable FIELD(s) from appearing in the output
  -i, --image <IMAGE>
          Path to the IMAGE file
      --image-protocol <IMAGE_PROTOCOL>
          Which image protocol to use [possible values: kitty, sixel, iterm]
      --color-resolution <VALUE>
          VALUE of color resolution to use with SIXEL backend [default: 16] [possible values: 16, 32, 64, 128, 256]
      --no-bold
          Turns off bold formatting
      --no-merges
          Ignores merge commits
      --no-color-palette
          Hides the color palette
      --no-title
          Hides the title
      --number-of-authors <NUM>
          Maximum NUM of authors to be shown [default: 3]
      --number-of-languages <NUM>
          Maximum NUM of languages to be shown [default: 6]
  -e, --exclude <EXCLUDE>...
          Ignore all files & directories matching EXCLUDE
      --no-bots [<REGEX>]
          Exclude [bot] commits. Use <REGEX> to override the default pattern
  -l, --languages
          Prints out supported languages
  -p, --package-managers
          Prints out supported package managers
  -o, --output <FORMAT>
          Outputs Onefetch in a specific format [possible values: json, yaml]
      --true-color <WHEN>
          Specify when to use true color [default: auto] [possible values: auto, never, always]
      --show-logo <WHEN>
          Specify when to show the logo [default: always] [possible values: auto, never, always]
  -t, --text-colors <X>...
          Changes the text colors (X X X...)
  -z, --iso-time
          Use ISO 8601 formatted timestamps
      --number-separator <SEPARATOR>
          Which thousands SEPARATOR to use [default: plain] [possible values: plain, comma, space, underscore]
  -E, --email
          Show the email address of each author
      --include-hidden
          Count hidden files and directories
  -T, --type <TYPE>...
          Filters output by language type [default: programming markup] [possible values: programming, markup, prose, data]
      --generate <SHELL>
          If provided, outputs the completion file for given SHELL [possible values: bash, elvish, fish, powershell, zsh]
  -h, --help
          Print help (see more with '--help')
  -V, --version
          Print version

After:

Command-line Git information tool

Usage: onefetch [OPTIONS] [INPUT]

Arguments:
  [INPUT]  Run as if onefetch was started in <input> instead of the current working directory

Options:
  -h, --help     Print help (see more with '--help')
  -V, --version  Print version

INFO:
  -d, --disabled-fields <FIELD>...  Allows you to disable FIELD(s) from appearing in the output
      --no-title                    Hides the title
      --number-of-authors <NUM>     Maximum NUM of authors to be shown [default: 3]
      --number-of-languages <NUM>   Maximum NUM of languages to be shown [default: 6]
  -e, --exclude <EXCLUDE>...        Ignore all files & directories matching EXCLUDE
      --no-bots [<REGEX>]           Exclude [bot] commits. Use <REGEX> to override the default pattern
      --no-merges                   Ignores merge commits
  -E, --email                       Show the email address of each author
      --include-hidden              Count hidden files and directories
  -T, --type <TYPE>...              Filters output by language type [default: programming markup] [possible values: programming, markup, prose, data]

TEXT FORMATTING:
  -t, --text-colors <X>...            Changes the text colors (X X X...)
  -z, --iso-time                      Use ISO 8601 formatted timestamps
      --number-separator <SEPARATOR>  Which thousands SEPARATOR to use [default: plain] [possible values: plain, comma, space, underscore]
      --no-bold                       Turns off bold formatting

COLOR BLOCKS:
      --no-color-palette  Hides the color palette

ASCII:
      --ascii-input <STRING>       Takes a non-empty STRING as input to replace the ASCII logo
  -c, --ascii-colors <X>...        Colors (X X X...) to print the ascii art
  -a, --ascii-language <LANGUAGE>  Which LANGUAGE's ascii art to print
      --true-color <WHEN>          Specify when to use true color [default: auto] [possible values: auto, never, always]
      --show-logo <WHEN>           Specify when to show the logo [default: always] [possible values: auto, never, always]

IMAGE:
  -i, --image <IMAGE>              Path to the IMAGE file
      --image-protocol <PROTOCOL>  Which image PROTOCOL to use [possible values: kitty, sixel, iterm]
      --color-resolution <VALUE>   VALUE of color resolution to use with SIXEL backend [default: 16] [possible values: 16, 32, 64, 128, 256]

DEVELOPER:
  -o, --output <FORMAT>   Outputs Onefetch in a specific format [possible values: json, yaml]
      --generate <SHELL>  If provided, outputs the completion file for given SHELL [possible values: bash, elvish, fish, powershell, zsh]

OTHER:
  -l, --languages         Prints out supported languages
  -p, --package-managers  Prints out supported package managers

@o2sh o2sh requested a review from spenserblack as a code owner April 1, 2023 16:58
Copy link
Collaborator

@spenserblack spenserblack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea! 👍

@o2sh o2sh merged commit 240fae7 into main Apr 1, 2023
@o2sh o2sh deleted the feat/help_sections branch April 1, 2023 22:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants