Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
raine committed Aug 26, 2023
1 parent 6e12461 commit 3ccf325
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ To authenticate `ghtool` with GitHub API, run:
ght login
```

#### On required permissions

The tool currently uses Github's OAuth device flow to authenticate users. To
access workflow job logs in OAuth flow which doesn't have fine grained
permissions, the `repo` scope, which grants a scary amount of permissions, is
needed. Github App auth flow enables more fine grained permissions, but doesn't
seem to work in the case where someone else than you owns the repository that
is queried. Incidentally, the official GitHub CLI tool also uses OAuth flow
with the `repo` scope and more ([link](https://github.com/raine/ghtool/assets/11027/c5b86639-07d0-4737-a2bc-519ead2f3b9f)).

## Usage

The tool is installed as executable `ght` for ease of use.
Expand Down

0 comments on commit 3ccf325

Please sign in to comment.