|
1 | 1 | --- |
2 | 2 | layout: default |
3 | | -title: Usage |
4 | | -nav_order: 4 |
| 3 | +title: Features & Usage |
| 4 | +nav_order: 2 |
5 | 5 | --- |
6 | 6 |
|
7 | | -# Usage |
| 7 | +# Features & Usage |
| 8 | + |
| 9 | +gitfetch brings the magic of neofetch to your git hosting platforms, displaying your coding activity in a stunning, colorful terminal interface that's both beautiful and highly customizable. |
| 10 | + |
| 11 | +## 🚀 Core Features |
| 12 | + |
| 13 | +- **Neofetch-style display** with stunning ASCII art that brings your stats to life |
| 14 | +- **Comprehensive statistics** from GitHub, GitLab, Gitea, Forgejo, Codeberg, and Sourcehut |
| 15 | +- **Smart SQLite-based caching** system for lightning-fast subsequent runs |
| 16 | +- **Cross-platform support** (macOS and Linux) - works wherever you code |
| 17 | +- **View active pull requests and issues** - stay on top of your contributions |
| 18 | +- **Display commit streak information** - track your coding momentum |
| 19 | +- **Extensive customization** options that let you make it truly yours |
| 20 | + |
| 21 | +## 🎨 Visual Customization |
| 22 | + |
| 23 | +Transform your gitfetch display with powerful visual options: |
| 24 | + |
| 25 | +- **Custom contribution characters** - use any symbol or emoji for your graph blocks |
| 26 | +- **Dynamic section control** - hide/show achievements, languages, issues, PRs, and more |
| 27 | +- **Flexible dimensions** - adjust width and height to fit your terminal perfectly |
| 28 | +- **ASCII art simulation** - create pixel art from text or use predefined shapes like kitty, cat, heart, and star |
| 29 | +- **Advanced color customization** with hex codes and predefined color schemes |
| 30 | + |
| 31 | +## 🧠 Intelligent Layout System |
| 32 | + |
| 33 | +gitfetch automatically adapts to your terminal environment: |
| 34 | + |
| 35 | +- **Full Layout**: Complete information display when you have 120+ columns |
| 36 | +- **Compact Layout**: Side-by-side graph and stats for medium terminals |
| 37 | +- **Minimal Layout**: Clean contribution graph for narrow screens |
| 38 | + |
| 39 | +The system intelligently considers both terminal width AND height to deliver the optimal viewing experience, no matter your setup. |
8 | 40 |
|
9 | 41 | ## Basic Usage |
10 | 42 |
|
@@ -43,20 +75,6 @@ Displays git commit timeline, built from local git history |
43 | 75 | - No language statistics for the repository |
44 | 76 | - Limited to local git history analysis |
45 | 77 |
|
46 | | -## Cache Options |
47 | | - |
48 | | -Bypass cache and fetch fresh data: |
49 | | - |
50 | | -```bash |
51 | | -gitfetch username --no-cache |
52 | | -``` |
53 | | - |
54 | | -Clear cache: |
55 | | - |
56 | | -```bash |
57 | | -gitfetch --clear-cache |
58 | | -``` |
59 | | - |
60 | 78 | ## Configuration |
61 | 79 |
|
62 | 80 | Change the configured git provider: |
@@ -116,6 +134,20 @@ gitfetch --no-grid # Hide contribution grid |
116 | 134 | gitfetch --no-date --no-achievements --custom-box "█" --width 60 |
117 | 135 | ``` |
118 | 136 |
|
| 137 | +## Cache Options |
| 138 | + |
| 139 | +Bypass cache and fetch fresh data: |
| 140 | + |
| 141 | +```bash |
| 142 | +gitfetch username --no-cache |
| 143 | +``` |
| 144 | + |
| 145 | +Clear cache: |
| 146 | + |
| 147 | +```bash |
| 148 | +gitfetch --clear-cache |
| 149 | +``` |
| 150 | + |
119 | 151 | ## Layout Control |
120 | 152 |
|
121 | 153 | gitfetch automatically adapts to your terminal size, but you can control spacing: |
|
0 commit comments