Skip to content

Commit 66427c2

Browse files
committed
docs: Enhance project documentation and metadata with detailed descriptions, use cases, safety information, and updated branding.
1 parent 72f6eb2 commit 66427c2

2 files changed

Lines changed: 85 additions & 7 deletions

File tree

README.md

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,25 @@
88
[![GitHub stars](https://img.shields.io/github/stars/Bharath-code/git-scope)](https://github.com/Bharath-code/git-scope/stargazers)
99
[![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-FFDD00?style=flat&logo=buy-me-a-coffee&logoColor=black)](https://buymeacoffee.com/iam_pbk)
1010

11+
🌐 **Website:** [bharath-code.github.io/git-scope](https://bharath-code.github.io/git-scope/)
12+
1113
![git-scope Demo](docs/git-scope-demo-1.webp)
1214

1315
---
1416

17+
## 🛡️ Trust & Safety
18+
19+
git-scope is designed to be safe to run frequently and safe to recommend.
20+
21+
- **Read-only by design** — it does not modify repositories
22+
- **Local-first** — no network access, no telemetry, no accounts
23+
- **Predictable** — no background services or daemons
24+
- **Conservative scope** — focused on visibility, not automation
25+
26+
These choices make git-scope suitable for daily use and work environments where reliability and transparency matter.
27+
28+
---
29+
1530
## ⚡ Installation
1631

1732
Get started in seconds.
@@ -94,6 +109,25 @@ git-scope -h # Show help
94109

95110
-----
96111

112+
## 🎯 Use Cases
113+
114+
git-scope excels in environments where multi-repo complexity is a daily burden:
115+
116+
* **Microservices Management** — Quickly verify if all your services are on the correct branch and have no unpushed changes.
117+
* **OSS Contribution Tracking** — Keep tabs on various upstream forks and personal branches in one view.
118+
* **Infrastructure as Code (IaC)** — Monitor multiple Terraform/CloudFormation repos for configuration drift or uncommitted edits.
119+
* **Context Recovery** — Instantly see where you left off after a weekend or a holiday without running `git status` 20 times.
120+
121+
-----
122+
123+
## 🏆 The git-scope Advantage
124+
125+
While many Git tools focus on the *micro* (committing, staging, diffing), git-scope is built for the *macro*.
126+
127+
Typical git workflows involve "tunnel vision"—working deep inside one repository. git-scope provides the "command center" view. It is intentionally **read-only**, **local-first**, and **blazing fast** (<10ms), making it the perfect companion to tools like `lazygit`, `gitui`, or VS Code.
128+
129+
-----
130+
97131
## ⌨️ Keyboard Shortcuts
98132

99133
| Key | Action |
@@ -156,11 +190,43 @@ I built `git-scope` to solve the **"Multi-Repo Blindness"** problem. It gives me
156190

157191
- [x] In-app workspace switching with Tab completion
158192
- [x] Symlink resolution for devcontainers/Codespaces
159-
- [ ] Background file watcher (real-time updates)
193+
- [x] Background file watcher (real-time updates)
160194
- [ ] Quick actions (bulk pull/fetch)
161195
- [ ] Repo grouping (Service / Team / Stack)
162196
- [ ] Custom team dashboards
163197

198+
## ❓ FAQ
199+
200+
### How do you manage multiple Git repositories locally?
201+
202+
git-scope provides a fast, read-only terminal dashboard that shows the status of many local Git repositories at once. It helps developers regain context across projects without switching directories or running commands repeatedly.
203+
204+
### What problem does git-scope solve?
205+
206+
git-scope reduces context switching when working across many Git repositories, such as microservices, tools, or configuration repos. It gives a single overview of repository state so developers can quickly see what needs attention.
207+
208+
### Is git-scope safe to use at work?
209+
210+
Yes. git-scope is read-only by design, runs entirely locally, has no network access or telemetry, and does not modify repositories. This makes it safe for daily and work use.
211+
212+
### Does git-scope replace git commands?
213+
214+
No. git-scope does not perform git actions like commit, push, or pull. It focuses on visibility and orientation, not automation.
215+
216+
### Is git-scope suitable for monorepos?
217+
218+
git-scope is designed for multi-repo (polyrepo) workflows. It is not intended to manage monorepos.
219+
220+
### What platforms does git-scope support?
221+
222+
git-scope runs on macOS, Linux, and Windows.
223+
224+
### How is git-scope different from other git TUIs?
225+
226+
Most git TUIs focus on interacting with a single repository. git-scope focuses on visibility across many repositories and stays intentionally read-only.
227+
228+
---
229+
164230
## 📄 License
165231

166232
MIT © [Bharath-code](https://github.com/Bharath-code)

docs/index.html

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,27 @@
2020
{
2121
"@context": "https://schema.org",
2222
"@type": "SoftwareApplication",
23-
"name": "Git-Scope",
23+
"name": "git-scope",
24+
"softwareVersion": "1.3.x",
2425
"applicationCategory": "DeveloperApplication",
26+
"applicationSubCategory": "Git Terminal Interface / Dashboard",
2527
"operatingSystem": "macOS, Linux, Windows",
2628
"offers": {
2729
"@type": "Offer",
2830
"price": "0",
2931
"priceCurrency": "USD"
3032
},
3133
"description": "A blazing fast TUI to manage, search, and clean up all your local git repositories. Zero config required.",
34+
"screenshot": "https://bharath-code.github.io/git-scope/git-scope-demo-1.webp",
35+
"featureList": [
36+
"Workspace Switcher (~, relative paths, symlinks)",
37+
"Fuzzy Search (name, path, branch)",
38+
"Dirty Filter (find unstaged/uncommitted changes)",
39+
"Blazing Fast (JSON caching, <10ms startup)",
40+
"Disk Usage Visualizer (git vs node_modules)",
41+
"Local Heatmap (contribution graph)",
42+
"Timeline View (recent activity across all projects)"
43+
],
3244
"author": {
3345
"@type": "Person",
3446
"name": "Bharath Kumar",
@@ -40,17 +52,17 @@
4052
<!-- Open Graph / Facebook -->
4153
<meta property="og:type" content="website">
4254
<meta property="og:url" content="https://bharath-code.github.io/git-scope/">
43-
<meta property="og:title" content="Git-Scope | Control Your Git Universe">
55+
<meta property="og:title" content="git-scope | Multi-Repo Terminal Dashboard">
4456
<meta property="og:description"
45-
content="A blazing fast TUI to manage, search, and clean up all your local git repositories. Zero config required.">
57+
content="Visualize your entire Git workspace in one screen. A fast, read-only TUI for managing microservices, OSS forks, and complex projects.">
4658
<meta property="og:image" content="https://bharath-code.github.io/git-scope/og-image.png">
4759

4860
<!-- Twitter -->
4961
<meta property="twitter:card" content="summary_large_image">
5062
<meta property="twitter:url" content="https://bharath-code.github.io/git-scope/">
51-
<meta property="twitter:title" content="Git-Scope | Control Your Git Universe">
63+
<meta property="twitter:title" content="git-scope | Multi-Repo Terminal Dashboard">
5264
<meta property="twitter:description"
53-
content="A blazing fast TUI to manage, search, and clean up all your local git repositories. Zero config required.">
65+
content="Visualize your entire Git workspace in one screen. A fast, read-only TUI for managing microservices and complex projects.">
5466
<meta property="twitter:image" content="https://bharath-code.github.io/git-scope/og-image.png">
5567

5668
<!-- Fonts -->
@@ -1570,7 +1582,7 @@ <h1 class="hero-animate">Stop <span class="gradient-text">cd-ing.</span> <br> St
15701582
<picture>
15711583
<source media="(max-width: 768px)" srcset="git-scope-demo-mobile-1.webp"
15721584
type="image/webp">
1573-
<img src="git-scope-demo-1.webp" alt="Git Scope Demo" loading="eager" width="1200"
1585+
<img src="git-scope-demo-1.webp" alt="git-scope Demo" loading="eager" width="1200"
15741586
height="800" style="width: 100%; height: auto; display: block;" decoding="async">
15751587
</picture>
15761588
</div>

0 commit comments

Comments
 (0)