mirror of https://github.com/o2sh/onefetch.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
200 lines
4.1 KiB
200 lines
4.1 KiB
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. |
|
.TH ONEFETCH "1" "April 2025" "onefetch 2.24.0" "User Commands" |
|
.SH NAME |
|
onefetch \- Command-line Git information tool |
|
.SH SYNOPSIS |
|
.B onefetch |
|
[\fI\,OPTIONS\/\fR] [\fI\,INPUT\/\fR] |
|
.SH DESCRIPTION |
|
Command\-line Git information tool |
|
.SS "Arguments:" |
|
.IP |
|
[INPUT] |
|
.IP |
|
Run as if onefetch was started in <input> instead of the current working directory |
|
.SH OPTIONS |
|
.HP |
|
\fB\-h\fR, \fB\-\-help\fR |
|
.IP |
|
Print help (see a summary with '\-h') |
|
.HP |
|
\fB\-V\fR, \fB\-\-version\fR |
|
.IP |
|
Print version |
|
.SS "INFO:" |
|
.HP |
|
\fB\-d\fR, \fB\-\-disabled\-fields\fR <FIELD>... |
|
.IP |
|
Allows you to disable FIELD(s) from appearing in the output |
|
.HP |
|
\fB\-\-no\-title\fR |
|
.IP |
|
Hides the title |
|
.HP |
|
\fB\-\-number\-of\-authors\fR <NUM> |
|
.IP |
|
Maximum NUM of authors to be shown |
|
.IP |
|
[default: 3] |
|
.HP |
|
\fB\-\-number\-of\-languages\fR <NUM> |
|
.IP |
|
Maximum NUM of languages to be shown |
|
.IP |
|
[default: 6] |
|
.HP |
|
\fB\-\-number\-of\-file\-churns\fR <NUM> |
|
.IP |
|
Maximum NUM of file churns to be shown |
|
.IP |
|
[default: 3] |
|
.HP |
|
\fB\-\-churn\-pool\-size\fR <NUM> |
|
.IP |
|
Minimum NUM of commits from HEAD used to compute the churn summary |
|
.IP |
|
By default, the actual value is non\-deterministic due to time\-based computation and will be displayed under the info title "Churn (NUM)" |
|
.HP |
|
\fB\-e\fR, \fB\-\-exclude\fR <EXCLUDE>... |
|
.IP |
|
Ignore all files & directories matching EXCLUDE |
|
.HP |
|
\fB\-\-no\-bots[=\fR<REGEX>] |
|
.IP |
|
Exclude [bot] commits. Use <REGEX> to override the default pattern |
|
.HP |
|
\fB\-\-no\-merges\fR |
|
.IP |
|
Ignores merge commits |
|
.HP |
|
\fB\-E\fR, \fB\-\-email\fR |
|
.IP |
|
Show the email address of each author |
|
.HP |
|
\fB\-\-http\-url\fR |
|
.IP |
|
Display repository URL as HTTP |
|
.HP |
|
\fB\-\-hide\-token\fR |
|
.IP |
|
Hide token in repository URL |
|
.HP |
|
\fB\-\-include\-hidden\fR |
|
.IP |
|
Count hidden files and directories |
|
.HP |
|
\fB\-T\fR, \fB\-\-type\fR <TYPE>... |
|
.IP |
|
Filters output by language type |
|
.IP |
|
[default: programming markup] |
|
[possible values: programming, markup, prose, data] |
|
.SS "TEXT FORMATTING:" |
|
.HP |
|
\fB\-t\fR, \fB\-\-text\-colors\fR <X>... |
|
.IP |
|
Changes the text colors (X X X...) |
|
.IP |
|
Goes in order of title, ~, underline, subtitle, colon, and info |
|
.IP |
|
For example: |
|
.IP |
|
\&'\-\-text\-colors 9 10 11 12 13 14' |
|
.HP |
|
\fB\-z\fR, \fB\-\-iso\-time\fR |
|
.IP |
|
Use ISO 8601 formatted timestamps |
|
.HP |
|
\fB\-\-number\-separator\fR <SEPARATOR> |
|
.IP |
|
Which thousands SEPARATOR to use |
|
.IP |
|
[default: plain] |
|
[possible values: plain, comma, space, underscore] |
|
.HP |
|
\fB\-\-no\-bold\fR |
|
.IP |
|
Turns off bold formatting |
|
.SS "ASCII:" |
|
.HP |
|
\fB\-\-ascii\-input\fR <STRING> |
|
.IP |
|
Takes a non\-empty STRING as input to replace the ASCII logo |
|
.IP |
|
It is possible to pass a generated STRING by command substitution |
|
.IP |
|
For example: |
|
.IP |
|
\&'\-\-ascii\-input "$(fortune | cowsay \fB\-W\fR 25)"' |
|
.HP |
|
\fB\-c\fR, \fB\-\-ascii\-colors\fR <X>... |
|
.IP |
|
Colors (X X X...) to print the ascii art |
|
.HP |
|
\fB\-a\fR, \fB\-\-ascii\-language\fR <LANGUAGE> |
|
.IP |
|
Which LANGUAGE's ascii art to print |
|
.HP |
|
\fB\-\-true\-color\fR <WHEN> |
|
.IP |
|
Specify when to use true color |
|
.IP |
|
If set to auto: true color will be enabled if supported by the terminal |
|
.IP |
|
[default: auto] |
|
[possible values: auto, never, always] |
|
.SS "IMAGE:" |
|
.HP |
|
\fB\-i\fR, \fB\-\-image\fR <IMAGE> |
|
.IP |
|
Path to the IMAGE file |
|
.HP |
|
\fB\-\-image\-protocol\fR <PROTOCOL> |
|
.IP |
|
Which image PROTOCOL to use |
|
.IP |
|
[possible values: kitty, sixel, iterm] |
|
.HP |
|
\fB\-\-color\-resolution\fR <VALUE> |
|
.IP |
|
VALUE of color resolution to use with SIXEL backend |
|
.IP |
|
[default: 16] |
|
[possible values: 16, 32, 64, 128, 256] |
|
.SS "VISUALS:" |
|
.HP |
|
\fB\-\-no\-color\-palette\fR |
|
.IP |
|
Hides the color palette |
|
.HP |
|
\fB\-\-no\-art\fR |
|
.IP |
|
Hides the ascii art or image if provided |
|
.HP |
|
\fB\-\-nerd\-fonts\fR |
|
.IP |
|
Use Nerd Font icons |
|
.IP |
|
Replaces language chips with Nerd Font icons |
|
.SS "DEVELOPER:" |
|
.HP |
|
\fB\-o\fR, \fB\-\-output\fR <FORMAT> |
|
.IP |
|
Outputs Onefetch in a specific format |
|
.IP |
|
[possible values: json, yaml] |
|
.HP |
|
\fB\-\-generate\fR <SHELL> |
|
.IP |
|
If provided, outputs the completion file for given SHELL |
|
.IP |
|
[possible values: bash, elvish, fish, powershell, zsh] |
|
.SS "OTHER:" |
|
.HP |
|
\fB\-l\fR, \fB\-\-languages\fR |
|
.IP |
|
Prints out supported languages |
|
.HP |
|
\fB\-p\fR, \fB\-\-package\-managers\fR |
|
.IP |
|
Prints out supported package managers
|
|
|