Skip to content

Commit

Permalink
Update README.md with notes for better GITHUB_TOKEN handling
Browse files Browse the repository at this point in the history
  • Loading branch information
pirafrank authored Sep 5, 2024
1 parent 6a6e9da commit 6308303
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ Alternatively, you can use an environment variable:
GITHUB_TOKEN="<your github token>" gama
```

You can also make it an alias for a better experience:

```bash
alias gama='GITHUB_TOKEN="<your github token>" command gama'
```

If you have the [GitHub CLI](https://cli.github.com/) installed, you automatically insert the var via:

```bash
Expand All @@ -56,6 +62,11 @@ GITHUB_TOKEN="$(gh auth token)" gama

This will skip needing to generate a token via the GitHub website.

> [!WARNING]
> For security reasons, you should not `export` your token globally in your shell.
> That would make it available to any app that can read environment variables.
> You should avoid committing it to your dotfiles repository, too.
## Build & Installation

### Using Docker
Expand Down

0 comments on commit 6308303

Please sign in to comment.