nxfetch 0.1.2

A minimal, fast and batteries included fetcher!
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

<h1 style="display: flex; justify-content: space-between;">
    <span>
      nxfetch
    </span>
    <span>
        <a href="https://builds.sr.ht/~sntx/nxfetch?"><img src="https://builds.sr.ht/~sntx/nxfetch.svg" alt="nxfetch status"></a>
    </span>
</h1>

A minimal, fast and batteries included fetcher!

> ```sh
> nxfetch
> ```
> ![image of nxfetch prompt](./.assets/preview.png "nxfetch without any flags")

## Installation

<details>
  <summary>Cargo</summary>

  ```sh
  cargo install --git https://git.sr.ht/~sntx/nxfetch --locked
  ```
</details>

<details>
  <summary>Cargo (manual)</summary>

  ```sh
  git clone https://git.sr.ht/~sntx/nxfetch && cd nxfetch
  cargo install --path . --locked
  ```
</details>

<details>
  <summary>Nix Shell</summary>

  ```sh
  nix shell sourcehut:~sntx/nxfetch
  ```
</details>

## Usage

```txt
Usage: nxfetch [OPTIONS] [MODULES]...

Arguments:
  [MODULES]...  A list of module names nxfetch should display [possible values: title, user, host, os, kernel, uptime, shell, cpu, memory, colours, colours-bright, empty]

Options:
      --no-module-names
          Whether to hide the module names
  -l, --logo <LOGO>
          Path to text file with ascii art to use as the logo
      --no-logo
          Whether to hide the logo
      --padding-before <PADDING_BEFORE>
          Padding before the fetch [default: 2]
      --padding-between <PADDING_BETWEEN>
          Padding between the logo and the text [default: 2]
  -r, --raw
          Only print raw module output (same as `--no-logo --no-module-names --padding-before 0`, takes precedence over those args)
  -h, --help
          Print help
  -V, --version
          Print version
```

## Performance

nxfetch 0.1.2 has been tested with [hyperfine](https://lib.rs/crates/hyperfine).

You can test nxfetch against other popular fetchers by running:

```sh
nix run .#benchmark
```

```sh
$ nix run .#benchmark

Benchmark 1: ./result/bin/nxfetch
  Time (mean ± σ):       0.8 ms ±   0.1 ms    [User: 0.3 ms, System: 0.4 ms]
  Range (min … max):     0.7 ms …   1.5 ms    3831 runs
 
Benchmark 2: afetch
  Time (mean ± σ):       1.7 ms ±   0.1 ms    [User: 1.2 ms, System: 0.6 ms]
  Range (min … max):     1.5 ms …   2.2 ms    1730 runs
 
Benchmark 3: bunnyfetch
  Time (mean ± σ):       1.3 ms ±   0.1 ms    [User: 0.5 ms, System: 1.0 ms]
  Range (min … max):     1.2 ms …   1.9 ms    2279 runs
 
Benchmark 4: neofetch
  Time (mean ± σ):     240.8 ms ±   2.4 ms    [User: 130.1 ms, System: 80.6 ms]
  Range (min … max):   236.7 ms … 246.0 ms    12 runs
 
Benchmark 5: pfetch
  Time (mean ± σ):      63.5 ms ±   1.4 ms    [User: 29.7 ms, System: 15.3 ms]
  Range (min … max):    61.6 ms …  68.8 ms    46 runs
 
Benchmark 6: profetch
  Time (mean ± σ):       1.2 ms ±   0.1 ms    [User: 0.6 ms, System: 0.5 ms]
  Range (min … max):     1.1 ms …   1.9 ms    2574 runs
 
Benchmark 7: yafetch
  Time (mean ± σ):      67.2 ms ±   1.0 ms    [User: 27.1 ms, System: 12.5 ms]
  Range (min … max):    66.2 ms …  72.7 ms    45 runs
 
Benchmark 8: inxi
  Time (mean ± σ):     469.2 ms ±   1.3 ms    [User: 70.2 ms, System: 47.2 ms]
  Range (min … max):   467.4 ms … 471.8 ms    10 runs
 
Summary
  './result/bin/nxfetch' ran
    1.54 ± 0.25 times faster than 'profetch'
    1.69 ± 0.24 times faster than 'bunnyfetch'
    2.17 ± 0.30 times faster than 'afetch'
   79.85 ± 10.01 times faster than 'pfetch'
   84.49 ± 10.50 times faster than 'yafetch'
  302.56 ± 37.44 times faster than 'neofetch'
  589.60 ± 72.74 times faster than 'inxi'
```

## Further Examples

> ```sh
> nxfetch --no-logo
> ```
> ![image of nxfetch prompt without ascii/ansi logo](./.assets/preview-no-logo.png "nxfetch with the --no-logo option")

> ```sh
> nxfetch --raw uptime
> ```
> `12h1m40s`

## License

This repository is GPL-3.0-or-later licensed.