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

Better help page #94

Merged
merged 2 commits into from
Sep 2, 2024
Merged

Better help page #94

merged 2 commits into from
Sep 2, 2024

Conversation

TornaxO7
Copy link
Contributor

Closes #78

Based on #91

@TornaxO7
Copy link
Contributor Author

Generated output of cargo run -- --help:

A TUI for crates.io

Usage: crates-tui [OPTIONS]

Options:
      --print-default-config
          Print default configuration

  -c, --config-file <FILE>
          A path to a crates-tui configuration file
          
          [default: /home/tornax/projects/crates-tui/.config/config.toml]

      --color-file <FILE>
          A path to a base16 color file
          
          [default: /home/tornax/projects/crates-tui/.config/color.yaml]

  -f, --frame-rate <FLOAT>
          Frame rate, i.e. number of frames per second
          
          [default: 15]

      --data-dir <DIR>
          The directory to use for storing application data
          
          [default: /home/tornax/projects/crates-tui/.data]

      --log-level <LEVEL>
          The log level to use. Valid values are: error, warn, info, debug, trace, off.
          
          [default: info]

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

@joshka
Copy link
Member

joshka commented Sep 2, 2024

Rebased, removed the nix changes, added a splash of color:

image image

@joshka joshka merged commit c9f1cb5 into ratatui:main Sep 2, 2024
6 checks passed
@github-actions github-actions bot mentioned this pull request Sep 2, 2024
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.

Better command line help defaults
2 participants