checkgit 0.1.0

Explore GitHub profiles and stats from your terminal
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

# checkgit

**checkgit** is a lightweight CLI tool that lets you explore your **GitHub profile, repositories, and contribution stats directly from your terminal**.

Instead of opening GitHub in a browser, you can simply run:

```
checkgit <username>
```

and instantly see your profile, top repositories, contribution stats, and activity heatmap right inside your terminal.

## Features

* **GitHub profile overview**

  * Name, username, bio
  * Followers & following
  * Repository count and total stars

* **Top repositories**

  * Displays your most starred repositories

* **Contribution statistics**

  * Commits
  * Pull Requests
  * Reviews
  * Issues

* **GitHub-style contribution heatmap**

  * View your yearly contributions directly in the terminal

* **Avatar rendering**

  * Displays your GitHub avatar inside the terminal (when supported)

## Installation

### Using Cargo

```
cargo install checkgit
```

---

## Usage

Run the command with a GitHub username:

```
checkgit <username>
```

Example:

```
checkgit torvalds
```

## GitHub Token Setup

To fetch contribution data and avoid rate limits, you need a **GitHub Personal Access Token**.

### Generate a token

1. Go to
   https://github.com/settings/tokens
2. Generate a **classic token**
3. No special permissions are required.

### Save the token

You can store the token using:

```
checkgit set-token <your_token>
```

or by setting an environment variable:

```
export GITHUB_TOKEN=<your_token>
```

## How It Works

`checkgit` uses the **GitHub REST API** and **GitHub GraphQL API** to fetch:

* Profile information
* Repository data
* Contribution statistics
* Contribution calendar

All data is then rendered directly in the terminal using ANSI colors and Unicode blocks.

## Built With

* **Rust**
* `reqwest` - HTTP client
* `tokio` - async runtime
* `serde` - JSON parsing
* `clap` - CLI argument parsing
* `viuer` - terminal image rendering
* `image` - avatar processing
* `colored` - terminal styling

## Contributing

Contributions are welcome!

Feel free to open an issue or submit a pull request if you have ideas for improvements or new features.

## Support

If you like this project, consider giving it a **star on GitHub** ⭐