Skip to content

Commit 82dd074

Browse files
Bharath-codeBharath-code
committed
docs: add marketing assets (landing page, vhs demo, copy)
- Added demo.tape for VHS GIF generation - Created docs/index.html (Neo-brutalist landing page) - Added docs/MARKETING_COPY.md for social submissions - Updated README.md with new features and launch info
1 parent 1ac9ce2 commit 82dd074

File tree

4 files changed

+373
-64
lines changed

4 files changed

+373
-64
lines changed

‎README.md‎

Lines changed: 32 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -2,113 +2,81 @@
22

33
> A fast TUI to see the status of all git repositories on your machine.
44
5-
![Status](https://img.shields.io/badge/status-MVP-blue)
6-
![Go Version](https://img.shields.io/badge/go-1.22-00ADD8)
5+
![Status](https://img.shields.io/badge/status-v2.0_Released-green)
6+
![Go Version](https://img.shields.io/badge/go-1.20+-00ADD8)
7+
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
8+
9+
<p align="center">
10+
<img src="demo.gif" alt="git-scope demo" width="600">
11+
</p>
12+
13+
**[🌐 Visit the Landing Page](https://bharath-code.github.io/git-scope/)**
714

815
## Overview
916

1017
**git-scope** is a terminal-based dashboard that helps you manage multiple git repositories. It scans your configured directories, shows you which repos have uncommitted changes, and lets you jump into your editor with a single keystroke.
1118

1219
### Features
1320

14-
- 🔍 **Scan** configured directories for git repos
15-
- 📊 **Dashboard** showing branch, dirty files, and last commit
16-
- ⌨️ **Keyboard-driven** navigation
17-
- 🚀 **Jump** into your editor from the TUI
18-
- ⚡ **Fast** concurrent scanning with goroutines
21+
- 🔍 **Fuzzy Search**: Find any repo by name, path, or branch with `/`
22+
- 🛡️ **Dirty Filter**: Press `f` to see only repos with uncommitted changes
23+
- ⚡ **Fast caching**: Instant startup using JSON caching
24+
- 📊 **Dashboard**: Shows branch, staged/unstaged counts, and last commit
25+
- ⌨️ **Keyboard-driven**: Vim-like navigation (`j`/`k`) and sorting (`s`)
26+
- 🚀 **Quick Jump**: Open any repo in your editor (VSCode, nvim, etc.) with `Enter`
1927

2028
## Installation
2129

22-
### From Source
23-
30+
### Homebrew (macOS/Linux)
2431
```bash
25-
go install github.com/Bharath-code/git-scope/cmd/git-scope@latest
32+
brew install Bharath-code/tap/git-scope
2633
```
2734

28-
Or clone and build:
29-
35+
### From Source
3036
```bash
31-
git clone https://github.com/Bharath-code/git-scope.git
32-
cd git-scope
33-
go build -o git-scope ./cmd/git-scope
37+
go install github.com/Bharath-code/git-scope/cmd/git-scope@latest
3438
```
3539

3640
## Usage
3741

38-
### Launch TUI Dashboard
39-
42+
### Launch TUI
4043
```bash
4144
git-scope
42-
# or
43-
git-scope tui
44-
```
45-
46-
### Scan and Output JSON
47-
48-
```bash
49-
git-scope scan
5045
```
5146

5247
### Configuration
53-
54-
Create a config file at `~/.config/git-scope/config.yml`:
48+
On first run, `git-scope` will auto-detect your directories. To customize, edit `~/.config/git-scope/config.yml`:
5549

5650
```yaml
57-
# Directories to scan for git repos
5851
roots:
5952
- ~/code
60-
- ~/projects
6153
- ~/work
6254

63-
# Directories to ignore
6455
ignore:
6556
- node_modules
66-
- .next
67-
- dist
68-
- build
69-
- target
7057
- .venv
71-
- vendor
7258

73-
# Editor to open repos (default: code)
74-
editor: code
59+
editor: code # or nvim, vim, helix
7560
```
7661
7762
## Keyboard Shortcuts
7863
7964
| Key | Action |
8065
|-----|--------|
81-
| `↑/↓` or `j/k` | Navigate repos |
82-
| `Enter` | Open repo in editor |
83-
| `r` | Rescan directories |
84-
| `q` | Quit |
85-
86-
## Dashboard Columns
87-
88-
| Column | Description |
89-
|--------|-------------|
90-
| Repo | Repository name |
91-
| Path | File path (truncated) |
92-
| Branch | Current branch |
93-
| Stg | Staged file count |
94-
| Unst | Unstaged file count |
95-
| Untrk | Untracked file count |
96-
| Last Commit | Last commit timestamp |
66+
| `/` | **Search** repos |
67+
| `f` | Toggle **Filter** (All/Dirty/Clean) |
68+
| `s` | Cycle **Sort** mode |
69+
| `1-4` | Sort by Dirty/Name/Branch/Recent |
70+
| `c` | **Clear** search & filters |
71+
| `Enter` | **Open** repo in editor |
72+
| `r` | **Rescan** directories |
73+
| `q` | **Quit** |
9774

9875
## Roadmap
9976

100-
- [ ] Caching for faster startup
101-
- [ ] Fuzzy search filter
102-
- [ ] Sort by different columns
103-
- [ ] Quick actions (pull, push)
10477
- [ ] Background file watcher
105-
106-
## Tech Stack
107-
108-
- **Go** - Fast, compiled binary
109-
- **Bubbletea** - TUI framework
110-
- **Lipgloss** - Terminal styling
111-
- **Bubbles** - TUI components
78+
- [ ] Quick actions (pull, push)
79+
- [ ] Team dashboards
11280

11381
## License
11482

‎demo.tape‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# VHS Tape for git-scope
2+
# To run this: vhs demo.tape
3+
# Install vhs: brew install vhs
4+
5+
Output demo.gif
6+
7+
Set FontSize 16
8+
Set Width 1200
9+
Set Height 800
10+
Set Padding 20
11+
Set FontFamily "JetBrains Mono"
12+
13+
# Setup the terminal look
14+
Set Theme "Catppuccin Mocha"
15+
16+
# Hide the prompt setup
17+
Hide
18+
Type "export PS1='> '"
19+
Enter
20+
Clear
21+
Show
22+
23+
# Start the demo
24+
Type "git-scope --help"
25+
Sleep 500ms
26+
Enter
27+
Sleep 2s
28+
29+
# Run the TUI
30+
Type "git-scope"
31+
Sleep 1s
32+
Enter
33+
Sleep 2s
34+
35+
# Navigate a bit
36+
Type "j"
37+
Sleep 500ms
38+
Type "j"
39+
Sleep 500ms
40+
Type "k"
41+
Sleep 500ms
42+
43+
# Show searching
44+
Type "/"
45+
Sleep 500ms
46+
Type "git"
47+
Sleep 300ms
48+
Type "-"
49+
Sleep 300ms
50+
Type "scope"
51+
Sleep 1s
52+
Enter
53+
Sleep 2s
54+
55+
# Show filtering
56+
Type "c"
57+
Sleep 1s
58+
Type "f"
59+
Sleep 1s
60+
Type "f"
61+
Sleep 1s
62+
Type "f"
63+
Sleep 1s
64+
65+
# Show sorting
66+
Type "s"
67+
Sleep 1s
68+
Type "s"
69+
Sleep 1s
70+
71+
# Quit
72+
Type "q"
73+
Sleep 1s

‎docs/MARKETING_COPY.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Marketing & Submission Copy
2+
3+
## Hacker News (Show HN)
4+
5+
**Title:** Show HN: git-scope — A fast TUI to manage all your git repos
6+
7+
**Comment:**
8+
Hi HN,
9+
10+
I built `git-scope` because I often work on 10+ microservices at once and lose track of which ones have uncommitted changes or are behind origin. existing tools were either too slow or too complex.
11+
12+
`git-scope` is a minimal TUI written in Go (using Bubble Tea) that:
13+
- recursively finds all git repos in your projects folder
14+
- shows a dashboard with dirty/clean status, branch, and sync status
15+
- fuzzy search (`/`), filter by status (`f`), and sort columns
16+
- opens the repo in your editor with one keypress
17+
- caches results for instant startup
18+
19+
It's open source and available via Homebrew.
20+
21+
Repo: https://github.com/Bharath-code/git-scope
22+
Landing Page: https://bharath-code.github.io/git-scope/
23+
24+
Would love your feedback!
25+
26+
---
27+
28+
## Reddit (r/golang, r/commandline, r/git)
29+
30+
**Title:** I built a TUI to manage all my local git repositories (Go + Bubble Tea)
31+
32+
**Body:**
33+
Hey everyone,
34+
35+
I wanted to share a tool I built to solve "repo chaos". It's called **git-scope**.
36+
37+
It scans your dev directories and gives you a bird's-eye view of all your repositories. You can instantly see which ones have uncommitted changes, are on the wrong branch, or have unsaved files.
38+
39+
**Features:**
40+
- ⚡️ Fast concurrent scanning + caching
41+
- 🔍 Fuzzy search for repo name/path
42+
- 🛡️ Filter by "Dirty" status to find lost work
43+
- 🎨 Modern TUI with Bubble Tea & Lipgloss
44+
- ⌨️ Vim-like navigation (j/k)
45+
46+
**Install:**
47+
```bash
48+
brew install Bharath-code/tap/git-scope
49+
# or
50+
go install github.com/Bharath-code/git-scope/cmd/git-scope@latest
51+
```
52+
53+
**Repo:** https://github.com/Bharath-code/git-scope
54+
55+
Feedback welcome!
56+
57+
---
58+
59+
## Awesome-Go Submission
60+
61+
**Entry:**
62+
[git-scope](https://github.com/Bharath-code/git-scope) - A fast TUI to visualize and manage multiple git repositories with fuzzy search and filtering.
63+
64+
**Section:**
65+
Development Tools or Version Control

0 commit comments

Comments
 (0)