ghfetch 0.1.0

GitHub stats in the terminal, neofetch-style
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

# ghfetch

[![CI](https://github.com/OneNoted/ghfetch/actions/workflows/ci.yml/badge.svg)](https://github.com/OneNoted/ghfetch/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/ghfetch.svg)](https://crates.io/crates/ghfetch)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![Rust](https://img.shields.io/badge/rust-1.85%2B-orange.svg)](https://www.rust-lang.org/)

GitHub stats in the terminal, neofetch-style.

`ghfetch` renders compact terminal cards for GitHub users, repositories, and organizations, with optional JSON output for scripting.

## Features

- User, repository, and organization views
- Catppuccin-based terminal themes
- Optional JSON output for shell scripts and other tooling
- Language breakdowns with detailed table mode
- Contribution and streak stats when authenticated

## Installation

### From crates.io

```bash
cargo install ghfetch
```

### From source

```bash
git clone https://github.com/OneNoted/ghfetch.git
cd ghfetch
cargo install --path .
```

## Authentication

`ghfetch` checks for authentication in this order:

1. `--token`
2. `GITHUB_TOKEN`
3. `GH_TOKEN`
4. `gh auth token`

Unauthenticated mode still works for public data, but GitHub rate limits are much lower and contribution data is unavailable.

## Usage

```bash
ghfetch octocat
ghfetch user octocat --all
ghfetch repo rust-lang/rust
ghfetch org rust-lang --languages
ghfetch octocat --json
ghfetch repo rust-lang/rust --theme latte
```

### Commands

- `ghfetch [username]`
- `ghfetch user <username>`
- `ghfetch repo <owner/repo>`
- `ghfetch org <orgname>`

### Common flags

- `--json` prints structured output instead of a card
- `--no-color` disables ANSI styling
- `--theme <mocha|macchiato|frappe|latte>` selects the card palette
- `--verbose` prints API request diagnostics to stderr

## Notes

- `ghfetch user <username>` shows a compact summary by default. Use `--all` to include every section, or specific section flags like `--repos` or `--languages`.
- `ghfetch org <orgname>` and `ghfetch repo <owner/repo>` show language summaries by default.
- Detailed language mode (`--languages`) prints a wider table instead of the card view.

## Development

```bash
cargo fmt --check
cargo clippy --all-targets --all-features -- -D warnings
cargo test
```

## License

MIT. See [LICENSE](LICENSE).