npm/cli and binary 📦 to generate a token from GitHub Apps.
Explore the docs »
Report Bug
·
Request Feature
GitHub Apps are the most powerful entity in the GitHub universe today. These Apps allow you to change a PR, add checks to a commit, trigger workflows and even (with the right permissions) commit code! But The tricky thing is, You need to generate a token every time you you want to use them.
This npm package / command line tool / binary will do just that!
You can install and use this package in different ways:
npx github-app-installation-token \
--appId <APP_ID> \
--installationId <INSTALLATION_ID> \
--privateKeyLocation <path/to/the/private.pem>
npm -g install github-app-installation-token
npm run github-app-installation-token \
--appId <APP_ID> \
--installationId <INSTALLATION_ID> \
--privateKeyLocation <path/to/the/private.pem>
yarn global add github-app-installation-token
github-app-installation-token \
--appId <APP_ID> \
--installationId <INSTALLATION_ID> \
--privateKeyLocation <path/to/the/private.pem>
import { getToken } from 'github-app-installation-token';
const { token } = await getToken({
appId: 1234,
installationId: 112345555, // https://developer.github.com/v3/apps/#list-installations-for-the-authenticated-app
privateKey: '-----BEGIN RSA PRIVATE KEY----- ......-----END RSA PRIVATE KEY-----', // the private key you took from the app. https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#generating-a-private-key
});
If you don't want any dependencies, you can use the binary directly.
Head over to releases and pick the binary for LINUX, MACOSX and WINDOWS.
If you are looking for a solution for your GitHub workflows, take a look at github-app-installation-token-action
Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.