Skip to content

Commit 41203d2

Browse files
committed
Adding explanation on how Access Tokens can increase Rate Limits
1 parent 47437da commit 41203d2

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/installing.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,19 @@ cd src/
3131
python3 -m gitxray.gitxray
3232
```
3333

34+
## Creating an Access Token to increase Rate Limits
35+
36+
Gitxray gracefully handles Rate Limits and can work out of the box without a GitHub API token, but you'll likely hit RateLimits pretty fast (A small to medium-size repository with 10+ Contributors could take hours to complete while it waits for RateLimits to reset) This is detailed by GitHub in their [documentation here](https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#primary-rate-limit-for-unauthenticated-users).
37+
38+
[Creating a simple read-only token scoped to PUBLIC repositories](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) will however help you increase those restrictions considerably. If you're not in a hurry or can leave gitxray running you'll be able to use its full capacity, as it pauses execution while waiting for the limits to lift.
39+
40+
You may then load the token safely by using (prevents the token from being displayed on screen or getting logged in your shell history):
41+
42+
```bash
43+
read -rs GH_ACCESS_TOKEN
44+
export
45+
```
46+
3447
## Command Line Arguments
3548

3649
### Required Arguments

0 commit comments

Comments
 (0)