@heroku-cli/plugin-certs-v5
Version:
heroku ssl plugin
459 lines • 13.1 kB
JSON
{
"version": "8.1.4",
"commands": {
"certs:add": {
"id": "certs:add",
"description": "add an SSL certificate to an app\nNote: certificates with PEM encoding are also valid",
"pluginName": "@heroku-cli/plugin-certs-v5",
"pluginType": "core",
"hidden": false,
"aliases": [],
"examples": "$ heroku certs:add example.com.crt example.com.key\n\n If you require intermediate certificates, refer to this article on merging certificates to get a complete chain:\n https://help.salesforce.com/s/articleView?id=000333504&type=1",
"flags": {
"bypass": {
"name": "bypass",
"type": "boolean",
"description": "bypass the trust chain completion step",
"required": false,
"allowNo": false
},
"app": {
"name": "app",
"type": "option",
"char": "a",
"description": "app to run command against",
"required": true
},
"remote": {
"name": "remote",
"type": "option",
"char": "r",
"description": "git remote of app to use"
}
},
"args": [
{
"name": "CRT",
"required": true
},
{
"name": "KEY",
"required": true
}
]
},
"certs:chain": {
"id": "certs:chain",
"description": "print an ordered & complete chain for a certificate\n",
"pluginName": "@heroku-cli/plugin-certs-v5",
"pluginType": "core",
"hidden": false,
"aliases": [],
"flags": {
"app": {
"name": "app",
"type": "option",
"char": "a",
"description": "app to run command against",
"required": true
},
"remote": {
"name": "remote",
"type": "option",
"char": "r",
"description": "git remote of app to use"
}
},
"args": []
},
"certs:generate": {
"id": "certs:generate",
"description": "generate a key and a CSR or self-signed certificate\nGenerate a key and certificate signing request (or self-signed certificate)\nfor an app. Prompts for information to put in the certificate unless --now\nis used, or at least one of the --subject, --owner, --country, --area, or\n--city options is specified.",
"pluginName": "@heroku-cli/plugin-certs-v5",
"pluginType": "core",
"hidden": false,
"aliases": [],
"examples": "$ heroku certs:generate example.com",
"flags": {
"selfsigned": {
"name": "selfsigned",
"type": "boolean",
"description": "generate a self-signed certificate instead of a CSR",
"required": false,
"allowNo": false
},
"keysize": {
"name": "keysize",
"type": "option",
"description": "RSA key size in bits (default: 2048)",
"required": false
},
"owner": {
"name": "owner",
"type": "option",
"description": "name of organization certificate belongs to",
"required": false
},
"country": {
"name": "country",
"type": "option",
"description": "country of owner, as a two-letter ISO country code",
"required": false
},
"area": {
"name": "area",
"type": "option",
"description": "sub-country area (state, province, etc.) of owner",
"required": false
},
"city": {
"name": "city",
"type": "option",
"description": "city of owner",
"required": false
},
"subject": {
"name": "subject",
"type": "option",
"description": "specify entire certificate subject",
"required": false
},
"now": {
"name": "now",
"type": "boolean",
"description": "do not prompt for any owner information",
"required": false,
"allowNo": false
},
"app": {
"name": "app",
"type": "option",
"char": "a",
"description": "app to run command against",
"required": true
},
"remote": {
"name": "remote",
"type": "option",
"char": "r",
"description": "git remote of app to use"
}
},
"args": [
{
"name": "domain",
"required": true
}
]
},
"certs": {
"id": "certs",
"description": "list SSL certificates for an app\n",
"pluginName": "@heroku-cli/plugin-certs-v5",
"pluginType": "core",
"hidden": false,
"aliases": [],
"flags": {
"app": {
"name": "app",
"type": "option",
"char": "a",
"description": "app to run command against",
"required": true
},
"remote": {
"name": "remote",
"type": "option",
"char": "r",
"description": "git remote of app to use"
}
},
"args": []
},
"certs:info": {
"id": "certs:info",
"description": "show certificate information for an SSL certificate\n",
"pluginName": "@heroku-cli/plugin-certs-v5",
"pluginType": "core",
"hidden": false,
"aliases": [],
"flags": {
"name": {
"name": "name",
"type": "option",
"description": "name to check info on",
"required": false
},
"endpoint": {
"name": "endpoint",
"type": "option",
"description": "endpoint to check info on",
"required": false
},
"show-domains": {
"name": "show-domains",
"type": "boolean",
"description": "show associated domains",
"required": false,
"allowNo": false
},
"app": {
"name": "app",
"type": "option",
"char": "a",
"description": "app to run command against",
"required": true
},
"remote": {
"name": "remote",
"type": "option",
"char": "r",
"description": "git remote of app to use"
}
},
"args": []
},
"certs:key": {
"id": "certs:key",
"description": "print the correct key for the given certificate\nYou must pass one single certificate, and one or more keys.\nThe first key that signs the certificate will be printed back.",
"pluginName": "@heroku-cli/plugin-certs-v5",
"pluginType": "core",
"hidden": false,
"aliases": [],
"examples": "$ heroku certs:key example.com.crt example.com.key",
"flags": {
"app": {
"name": "app",
"type": "option",
"char": "a",
"description": "app to run command against",
"required": true
},
"remote": {
"name": "remote",
"type": "option",
"char": "r",
"description": "git remote of app to use"
}
},
"args": []
},
"certs:remove": {
"id": "certs:remove",
"description": "remove an SSL certificate from an app\n",
"pluginName": "@heroku-cli/plugin-certs-v5",
"pluginType": "core",
"hidden": false,
"aliases": [],
"flags": {
"confirm": {
"name": "confirm",
"type": "option",
"hidden": true,
"required": false
},
"name": {
"name": "name",
"type": "option",
"description": "name to remove",
"required": false
},
"endpoint": {
"name": "endpoint",
"type": "option",
"description": "endpoint to remove",
"required": false
},
"app": {
"name": "app",
"type": "option",
"char": "a",
"description": "app to run command against",
"required": true
},
"remote": {
"name": "remote",
"type": "option",
"char": "r",
"description": "git remote of app to use"
}
},
"args": []
},
"certs:update": {
"id": "certs:update",
"description": "update an SSL certificate on an app\nNote: certificates with PEM encoding are also valid",
"pluginName": "@heroku-cli/plugin-certs-v5",
"pluginType": "core",
"hidden": false,
"aliases": [],
"examples": "$ heroku certs:update example.com.crt example.com.key\n\n If you require intermediate certificates, refer to this article on merging certificates to get a complete chain:\n https://help.salesforce.com/s/articleView?id=000333504&type=1",
"flags": {
"bypass": {
"name": "bypass",
"type": "boolean",
"description": "bypass the trust chain completion step",
"required": false,
"allowNo": false
},
"confirm": {
"name": "confirm",
"type": "option",
"hidden": true,
"required": false
},
"name": {
"name": "name",
"type": "option",
"description": "name to update",
"required": false
},
"endpoint": {
"name": "endpoint",
"type": "option",
"description": "endpoint to update",
"required": false
},
"app": {
"name": "app",
"type": "option",
"char": "a",
"description": "app to run command against",
"required": true
},
"remote": {
"name": "remote",
"type": "option",
"char": "r",
"description": "git remote of app to use"
}
},
"args": [
{
"name": "CRT",
"required": true
},
{
"name": "KEY",
"required": true
}
]
},
"certs:auto:disable": {
"id": "certs:auto:disable",
"description": "disable ACM for an app\n",
"pluginName": "@heroku-cli/plugin-certs-v5",
"pluginType": "core",
"hidden": false,
"aliases": [],
"flags": {
"confirm": {
"name": "confirm",
"type": "option",
"hidden": true,
"required": false
},
"app": {
"name": "app",
"type": "option",
"char": "a",
"description": "app to run command against",
"required": true
},
"remote": {
"name": "remote",
"type": "option",
"char": "r",
"description": "git remote of app to use"
}
},
"args": []
},
"certs:auto:enable": {
"id": "certs:auto:enable",
"description": "enable ACM status for an app\n",
"pluginName": "@heroku-cli/plugin-certs-v5",
"pluginType": "core",
"hidden": false,
"aliases": [],
"flags": {
"wait": {
"name": "wait",
"type": "boolean",
"description": "watch ACM status and exit when complete",
"required": false,
"allowNo": false
},
"app": {
"name": "app",
"type": "option",
"char": "a",
"description": "app to run command against",
"required": true
},
"remote": {
"name": "remote",
"type": "option",
"char": "r",
"description": "git remote of app to use"
}
},
"args": []
},
"certs:auto": {
"id": "certs:auto",
"description": "show ACM status for an app\n",
"pluginName": "@heroku-cli/plugin-certs-v5",
"pluginType": "core",
"hidden": false,
"aliases": [],
"flags": {
"wait": {
"name": "wait",
"type": "boolean",
"description": "watch ACM status and display the status when complete",
"required": false,
"allowNo": false
},
"app": {
"name": "app",
"type": "option",
"char": "a",
"description": "app to run command against",
"required": true
},
"remote": {
"name": "remote",
"type": "option",
"char": "r",
"description": "git remote of app to use"
}
},
"args": []
},
"certs:auto:refresh": {
"id": "certs:auto:refresh",
"description": "refresh ACM for an app\n",
"pluginName": "@heroku-cli/plugin-certs-v5",
"pluginType": "core",
"hidden": false,
"aliases": [],
"flags": {
"app": {
"name": "app",
"type": "option",
"char": "a",
"description": "app to run command against",
"required": true
},
"remote": {
"name": "remote",
"type": "option",
"char": "r",
"description": "git remote of app to use"
}
},
"args": []
}
}
}