https://github.com/mackee/git-credential-github-apps
https://github.com/mackee/git-credential-github-apps
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mackee/git-credential-github-apps
- Owner: mackee
- License: mit
- Created: 2019-12-05T07:50:45.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-18T11:49:36.000Z (over 1 year ago)
- Last Synced: 2025-03-14T16:03:56.500Z (over 1 year ago)
- Language: Go
- Size: 23.4 KB
- Stars: 23
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# git-credential-github-apps
A git credential helper with GitHub Apps
## Overview
`git-credential-github-apps` provides authentication behavior in GitHub Apps on git commands.
This command returns credentials that GitHub Token. Also, that response contains a cached token while during in not expire.
`git-credential-github-apps` is work as git-credential-helper. If you want to know more details, see the `Install` section in this document and [this document](https://git-scm.com/docs/api-credentials).
## Install
Download latest version from [Releases](https://github.com/mackee/git-credential-github-apps/releases).
Extract into a directory that written in your PATH environment variable.
## Usage
### Prepare
Using this tool requires a private key, App ID and Installation ID or organization name.
You will get a private key and App ID on the Config page at GitHub Apps.
More details for private key: [Generating a private key](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#generating-a-private-key)
Installation ID is the identifier of installation organization on GitHub Apps
Organization name can be alternate to installation ID. `git-credential-github-apps` detect installation ID from organization name.
### Install to git
Type following this. This is set credential helper to git configuration in global.
```console
$ git config --global credential.helper 'github-apps -privatekey -appid -login '
```
If you want to set to repository local, you will type following this on directory of the repository.
```console
git config --global credential.helper 'github-apps -privatekey -appid -login '
```
### More Options
If you want to know more options, execution `git-credential-github-apps` with `-h`.
## Author
mackee, KAYAC Inc.
## License
[MIT](./LICENSE)