gdk
github-deploy-key
npm i github-deploy-key
gdk

github-deploy-key

A cli to add deploy keys to a repo

by Oli Evans

1.0.2 (see all)License:AGPL-3.0TypeScript:Not Found
npm i github-deploy-key
Readme

github-deploy-key

A cli to generate and add SSH deploy keys to private repos

Saves you from having to remember the ssh-keygen args and then fumble around on github like an animal 🐯

npm install -g github-deploy-key

Usage

github-deploy-key add [repo] --token <rando>

#e.g.
github-deploy-key add olizilla/github-deploy-key --token deadbeef

Where:

  • [repo] is 1 or more repos that you want to add ssh deploy keys to.
  • --token <rando> is a github access token

Running the above will create a new random ssh keypair and POST the public key to the add deploy key github api, and mark it as read_only: true as that's best. This is a disposable deploy key after all, and has no business being used to change the repo.

The private key will be logged out to the console, for you to add to your vault or deploy bots or whatever automagic you choose to set up. It's imbued with enough power to clone the private repo you just added it's public counterpart to, so keep it away from burglars and kids.

You can go check https://github.com/olizilla/github-deploy-key/settings/keys or the equivalent for your repo to see the public key was added.

The key-pair are also dumped in the current working directory like so:

./<repo>/<timestamp>/id_rsa{.pub}

# e.g
olizilla
└── github-deploy-key
    └── 1465248385267
        ├── id_rsa
        └── id_rsa.pub

It's probably best to burn them as soon as you've shuffled the private key onto the CI server that'll use it, but they're there for you convenience, to delete at your leisure.

This module uses rc so you can save yourself a copy paste by storing your github http access token to any config file it supports, like

  • $HOME/.${appname}rc
  • /etc/${appname}rc

Though again, it's then on you to keep that file safe from burglars and the deranged.


A (╯°□°)╯︵TABLEFLIP side project.

Downloads/wk

0

GitHub Stars

10

LAST COMMIT

6yrs ago

MAINTAINERS

1

CONTRIBUTORS

0

OPEN ISSUES

1

OPEN PRs

1
VersionTagPublished
1.0.2
latest
6yrs ago
No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100
No reviews found
Be the first to rate