Skip to content

Commit 2b61636

Browse files
📝 [+doc] Updated docs to cover new functionality (#24)
2 parents 24e3da5 + d4370d5 commit 2b61636

3 files changed

Lines changed: 42 additions & 10 deletions

File tree

README.md

Lines changed: 42 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,29 +25,59 @@
2525
- [License](#license)
2626

2727
## Overview
28-
`AllGitStatus` is a [Text-based user interface](https://en.wikipedia.org/wiki/Text-based_user_interface) (TUI) that checks the git status for all repositories found under the specified directory. It can be used to quickly understand the status of multiple repositories stored under the same common ancestor. Additionally, it can be used to pull or push changes to/from a remote when changes are detected.
28+
`AllGitStatus` is a [Text-based user interface](https://en.wikipedia.org/wiki/Text-based_user_interface) (TUI) application that displays the git status of all repositories found under a specified directory. Perfect for developers managing multiple repositories who need a quick, comprehensive overview of their project states without navigating into each one individually.
2929

30-
<img width="1608" height="970" alt="screenshot" src="https://github.com/user-attachments/assets/807d2857-e5a3-4680-968d-91f948d9d730" />
30+
<img width="1689" height="977" alt="screenshot" src="https://github.com/user-attachments/assets/78ea504e-de51-4840-b448-c1cc4d6c78f3" />
3131

3232
[Screenshot of `AllGitStatus`]
3333

34-
https://github.com/user-attachments/assets/14956748-39e8-489c-800b-feae67c5e579
34+
https://github.com/user-attachments/assets/596e3791-ce25-4872-8102-a004c22e5286
3535

3636
[Demo of `AllGitStatus`]
3737

38+
### Features
39+
40+
#### Local Git Information:
41+
42+
- Current branch name with detached HEAD detection
43+
- Local changes summary (staged ✅, unstaged 🟡, untracked ❓)
44+
- Stash count (🧺)
45+
- Remote sync status showing commits to push (🔼) or pull (🔽)
46+
47+
48+
#### GitHub Integration (when a GitHub PAT is provided):
49+
50+
- Stars (⭐), forks (🍴), and watchers (👀) count
51+
- Open issues with labels and authors (🐛)
52+
- Open pull requests with draft status (🔀)
53+
- Security/Dependabot alerts with severity breakdown (🔒🔔⚠️🚨)
54+
- CI/CD workflow status (✅❌⏳)
55+
- Repository archived status (📦)
3856

3957
### How to use `AllGitStatus`
4058

41-
`AllGitStatus` can be run directly via [uv](https://github.com/astral-sh/uv) or installed as a python package.
59+
Run directly with `uvx` (no installation required):
4260

43-
#### Running with `uv`
61+
#### Check all repositories under the current directory
62+
`uvx AllGitStatus`
4463

45-
Ensure that `uv` is installed and available on the path. Instructions on installing `uv` are available at https://docs.astral.sh/uv/#installation.
64+
#### Check repositories under a specific directory
65+
`uvx AllGitStatus /path/to/projects`
4666

47-
| Command Line | Scenario |
48-
| --- | --- |
49-
| `uvx AllGitStatus` | To run using the current directory as the root of all git repositories. |
50-
| `uvx AllGitStatus <path to directory>` | To run using the specified directory as the root of all git repositories. |
67+
#### Enable GitHub integration with a Personal Access Token (NOT RECOMMENDED)
68+
`uvx AllGitStatus --pat ghp_your_token_here`
69+
70+
#### The PAT can also be a path to a file containing the token (RECOMMENDED)
71+
`uvx AllGitStatus --pat ~/.github_pat`
72+
73+
#### Or use an environment variable for the PAT
74+
```
75+
export ALLGITSTATUS_PAT=ghp_your_token_or_filename_here
76+
uvx AllGitStatus
77+
```
78+
79+
#### Enable debug mode for troubleshooting
80+
`uvx AllGitStatus --debug`
5181

5282
#### Running as a python package
5383

@@ -62,6 +92,8 @@ Install `AllGitStatus` as a python package using the [instructions below](#insta
6292

6393
## Installation
6494

95+
Note that installation is not required when running `AllGitStatus` via `uvx`.
96+
6597
| Installation Method | Command |
6698
| --- | --- |
6799
| Via [uv](https://github.com/astral-sh/uv) | `uv add AllGitStatus` |

images/demo.mp4

9.56 MB
Binary file not shown.

images/screenshot.png

23.1 KB
Loading

0 commit comments

Comments
 (0)