Skip to content

Commit

Permalink
Merge branch 'main' into feature/i31-live-mode
Browse files Browse the repository at this point in the history
  • Loading branch information
canack committed Dec 17, 2024
2 parents 8ca134e + 5063d35 commit f168b6a
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

GAMA is a powerful terminal-based user interface tool designed to streamline the management of GitHub Actions workflows. It allows developers to list, trigger, and manage workflows with ease directly from the terminal.

<a href="https://github.com/termkit/gama" target="_blank"><img src="https://img.shields.io/github/go-mod/go-version/termkit/gama?style=for-the-badge&logo=go" alt="GAMA Go Version" /></a>
<a href="https://goreportcard.com/report/github.com/termkit/gama" target="_blank"><img src="https://goreportcard.com/badge/github.com/termkit/gama?style=for-the-badge&logo=go" alt="GAMA Go Report Card" /></a>
<a href="https://github.com/termkit/gama" target="_blank"><img src="https://img.shields.io/github/license/termkit/gama?style=for-the-badge" alt="GAMA Licence" /></a>

![gama demo](docs/gama.gif)

## Key Features
Expand Down Expand Up @@ -44,6 +48,25 @@ 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
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 f168b6a

Please sign in to comment.