You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A neofetch-style CLI tool for GitHubstatistics. Display your GitHub profile and stats in a beautiful, colorful terminal interface.
3
+
A neofetch-style CLI tool for GitHub, GitLab, Gitea, Forgejo, Codeberg, and Sourcehut statistics. Display your profile and stats from various git hosting platforms in a beautiful, colorful terminal interface.
@@ -9,41 +9,33 @@ A neofetch-style CLI tool for GitHub statistics. Display your GitHub profile and
9
9
## Features
10
10
11
11
- Neofetch-style display with ASCII art
12
-
- Comprehensive GitHub statistics
12
+
- Comprehensive statistics from multiple git hosting platforms
13
13
- Smart SQLite-based caching system for faster subsequent runs
14
14
- Persistent configuration with default username support
15
-
- Uses GitHub CLI (gh) for authentication - no rate limits!
16
15
- Cross-platform support (macOS and Linux)
17
-
- First-run initialization with interactive setup
16
+
- First-run initialization with interactive provider selection
18
17
19
-
## Prerequisites
18
+
## Supported Platforms
20
19
21
-
**GitHub CLI (gh) must be installed and authenticated:**
20
+
-**GitHub** - Uses GitHub CLI (gh) for authentication
21
+
-**GitLab** - Uses GitLab CLI (glab) for authentication
22
+
-**Gitea/Forgejo/Codeberg** - Uses personal access tokens
23
+
-**Sourcehut** - Uses personal access tokens
22
24
23
-
See installation instructions at: https://github.com/cli/cli#installation
25
+
## Installation
24
26
25
-
### macOS
27
+
`gitfetch` can be installed without any prerequisites. During first-run setup, you'll be guided to install and authenticate with the necessary CLI tools or provide access tokens for your chosen git hosting platform.
26
28
27
-
```bash
28
-
brew install gh
29
-
gh auth login
30
-
```
31
-
32
-
### Linux
33
-
34
-
Then authenticate:
35
-
36
-
```bash
37
-
gh auth login
38
-
```
29
+
## First-run Setup
39
30
40
-
### Verify Installation
31
+
When you run `gitfetch` for the first time, you'll be prompted to:
41
32
42
-
```bash
43
-
gh auth status
44
-
```
33
+
1.**Choose your git hosting provider** (GitHub, GitLab, Gitea/Forgejo/Codeberg, or Sourcehut)
34
+
2.**Install required CLI tools** (if using GitHub or GitLab)
35
+
3.**Authenticate** with your chosen platform
36
+
4.**Configure access tokens** (if using Gitea/Forgejo/Codeberg or Sourcehut)
45
37
46
-
You should see: `✓ Logged in to github.com as YOUR_USERNAME`
38
+
The setup process will provide helpful error messages and installation instructions if anything is missing.
The configuration file is automatically created on first runand contains two main sections:
160
+
The configuration file is automatically created on first run. See `docs/providers.md` for detailed provider configuration and `docs/colors.md` for color customization options.
169
161
170
162
### [DEFAULT] Section
171
163
172
164
```ini
173
165
[DEFAULT]
174
166
username = yourusername
175
167
cache_expiry_hours = 24
168
+
provider = github
169
+
provider_url = https://api.github.com
176
170
```
177
171
178
-
-`username`: Your default GitHub username (automatically set from authenticated GitHub CLI user)
172
+
-`username`: Your default username (automatically detected)
179
173
-`cache_expiry_hours`: How long to keep cached data (default: 24 hours)
0 commit comments