@probot/get-private-key
v2.0.0@probot/get-private-key
Get private key from a file path, environment variables, or a
*.pem
file in the current working directory
Finds a private key through various user-(un)specified methods. Order of precedence:
- Explicit file path option
PRIVATE_KEY
environment variable or explicitenv.PRIVATE_KEY
option. The private key can optionally be base64 encoded.PRIVATE_KEY_PATH
environment variable or explicitenv.PRIVATE_KEY_PATH
option- Any file w/
.pem
extension in current working dir
Supports both PKCS1 (i.e -----BEGIN RSA PRIVATE KEY-----
) and PKCS8 (i.e -----BEGIN PRIVATE KEY-----
).
Usage
Browsers |
|
---|---|
Node |
Install with
|
const probot = new Probot({
appId: 123,
privateKey: getPrivateKey(),
});
Options
name | type | description |
---|---|---|
options.filepath
|
string |
Pass a path to a
|
options.cwd
|
string |
Defaults to
|
options.env
|
object |
Defaults to
|