@heroku-cli/plugin-mtls 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md ADDED
@@ -0,0 +1 @@
1
+ ## [1.0.1](https://github.com/heroku/heroku-cli-plugin-mtls/compare/v0.9.2...v1.0.1) (2025-11-05)
package/README.md CHANGED
@@ -30,7 +30,7 @@ $ heroku plugins:install @heroku-cli/plugin-mtls
30
30
 
31
31
  ## `heroku data:mtls ADDON`
32
32
 
33
- get the status of MTLS for your addon
33
+ get the status of mTLS for your add-on
34
34
 
35
35
  ```
36
36
  USAGE
@@ -43,17 +43,17 @@ FLAGS
43
43
  -a, --app=<value> (required) app to run command against
44
44
 
45
45
  DESCRIPTION
46
- get the status of MTLS for your addon
46
+ get the status of mTLS for your add-on
47
47
 
48
48
  EXAMPLES
49
49
  $ heroku data:mtls postgresql-sushi-12345 -a example-app
50
50
  ```
51
51
 
52
- _See code: [src/commands/data/mtls/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/index.ts)_
52
+ _See code: [src/commands/data/mtls/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/index.ts)_
53
53
 
54
54
  ## `heroku data:mtls:certificates ADDON`
55
55
 
56
- get the certificates for your MTLS enabled addon
56
+ get the certificates for your mTLS enabled add-on
57
57
 
58
58
  ```
59
59
  USAGE
@@ -66,17 +66,17 @@ FLAGS
66
66
  -a, --app=<value> (required) app to run command against
67
67
 
68
68
  DESCRIPTION
69
- get the certificates for your MTLS enabled addon
69
+ get the certificates for your mTLS enabled add-on
70
70
 
71
71
  EXAMPLES
72
72
  $ heroku data:mtls:certificates postgresql-sushi-12345 -a example-app
73
73
  ```
74
74
 
75
- _See code: [src/commands/data/mtls/certificates/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/certificates/index.ts)_
75
+ _See code: [src/commands/data/mtls/certificates/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/certificates/index.ts)_
76
76
 
77
77
  ## `heroku data:mtls:certificates:create ADDON`
78
78
 
79
- create a new certificate for your MTLS enabled addon
79
+ create a new certificate for your mTLS enabled add-on
80
80
 
81
81
  ```
82
82
  USAGE
@@ -89,17 +89,17 @@ FLAGS
89
89
  -a, --app=<value> (required) app to run command against
90
90
 
91
91
  DESCRIPTION
92
- create a new certificate for your MTLS enabled addon
92
+ create a new certificate for your mTLS enabled add-on
93
93
 
94
94
  EXAMPLES
95
95
  $ heroku data:mtls:certificates:create postgresql-sushi-12345 -a example-app
96
96
  ```
97
97
 
98
- _See code: [src/commands/data/mtls/certificates/create.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/certificates/create.ts)_
98
+ _See code: [src/commands/data/mtls/certificates/create.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/certificates/create.ts)_
99
99
 
100
100
  ## `heroku data:mtls:certificates:delete ADDON`
101
101
 
102
- delete a specific certificate for your MTLS enabled addon
102
+ delete a specific certificate for your mTLS enabled add-on
103
103
 
104
104
  ```
105
105
  USAGE
@@ -113,17 +113,17 @@ FLAGS
113
113
  --id=<value> (required) id of certificate
114
114
 
115
115
  DESCRIPTION
116
- delete a specific certificate for your MTLS enabled addon
116
+ delete a specific certificate for your mTLS enabled add-on
117
117
 
118
118
  EXAMPLES
119
119
  $ heroku data:mtls:certificates:delete postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app
120
120
  ```
121
121
 
122
- _See code: [src/commands/data/mtls/certificates/delete.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/certificates/delete.ts)_
122
+ _See code: [src/commands/data/mtls/certificates/delete.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/certificates/delete.ts)_
123
123
 
124
124
  ## `heroku data:mtls:certificates:download ADDON`
125
125
 
126
- download your certificate bundle for your mTLS addon
126
+ download your certificate bundle for your mTLS add-on
127
127
 
128
128
  ```
129
129
  USAGE
@@ -139,7 +139,7 @@ FLAGS
139
139
  --prefix=<value> (required) prefix to put in front of downloaded file names
140
140
 
141
141
  DESCRIPTION
142
- download your certificate bundle for your mTLS addon
142
+ download your certificate bundle for your mTLS add-on
143
143
 
144
144
  EXAMPLES
145
145
  $ heroku data:mtls:certificates:download postgresql-sushi-12345 --id "3559a4df-2c82-4473-86cf-181310a6ef4f" -a example-app
@@ -149,11 +149,11 @@ EXAMPLES
149
149
  $ heroku data:mtls:certificates:download postgresql-sushi-12345 --id "3559a4df-2c82-4473-86cf-181310a6ef4f --prefix "prefix_" -a example-app
150
150
  ```
151
151
 
152
- _See code: [src/commands/data/mtls/certificates/download.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/certificates/download.ts)_
152
+ _See code: [src/commands/data/mtls/certificates/download.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/certificates/download.ts)_
153
153
 
154
154
  ## `heroku data:mtls:certificates:get ADDON`
155
155
 
156
- get a specific certificate for your MTLS enabled addon
156
+ get a specific certificate for your mTLS enabled add-on
157
157
 
158
158
  ```
159
159
  USAGE
@@ -167,13 +167,13 @@ FLAGS
167
167
  --id=<value> (required) id of IP Rule
168
168
 
169
169
  DESCRIPTION
170
- get a specific certificate for your MTLS enabled addon
170
+ get a specific certificate for your mTLS enabled add-on
171
171
 
172
172
  EXAMPLES
173
173
  $ heroku data:mtls:certificates:get postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app
174
174
  ```
175
175
 
176
- _See code: [src/commands/data/mtls/certificates/get.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/certificates/get.ts)_
176
+ _See code: [src/commands/data/mtls/certificates/get.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/certificates/get.ts)_
177
177
 
178
178
  ## `heroku data:mtls:create ADDON`
179
179
 
@@ -196,11 +196,11 @@ EXAMPLES
196
196
  $ heroku data:mtls:create postgresql-sushi-12345 -a example-app
197
197
  ```
198
198
 
199
- _See code: [src/commands/data/mtls/create.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/create.ts)_
199
+ _See code: [src/commands/data/mtls/create.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/create.ts)_
200
200
 
201
201
  ## `heroku data:mtls:delete ADDON`
202
202
 
203
- destroy MTLS configuration on your addon
203
+ disable mTLS for your add-on
204
204
 
205
205
  ```
206
206
  USAGE
@@ -213,7 +213,7 @@ FLAGS
213
213
  -a, --app=<value> (required) app to run command against
214
214
 
215
215
  DESCRIPTION
216
- destroy MTLS configuration on your addon
216
+ disable mTLS for your add-on
217
217
 
218
218
  ALIASES
219
219
  $ heroku data:mtls:delete
@@ -224,7 +224,7 @@ EXAMPLES
224
224
 
225
225
  ## `heroku data:mtls:destroy ADDON`
226
226
 
227
- destroy MTLS configuration on your addon
227
+ disable mTLS for your add-on
228
228
 
229
229
  ```
230
230
  USAGE
@@ -237,7 +237,7 @@ FLAGS
237
237
  -a, --app=<value> (required) app to run command against
238
238
 
239
239
  DESCRIPTION
240
- destroy MTLS configuration on your addon
240
+ disable mTLS for your add-on
241
241
 
242
242
  ALIASES
243
243
  $ heroku data:mtls:delete
@@ -246,11 +246,11 @@ EXAMPLES
246
246
  $ heroku data:mtls:destroy postgresql-sushi-12345 -a example-app
247
247
  ```
248
248
 
249
- _See code: [src/commands/data/mtls/destroy.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/destroy.ts)_
249
+ _See code: [src/commands/data/mtls/destroy.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/destroy.ts)_
250
250
 
251
251
  ## `heroku data:mtls:ip-rules ADDON`
252
252
 
253
- get the IP Rules for your MTLS enabled addon
253
+ get the IP Rules for your mTLS enabled add-on
254
254
 
255
255
  ```
256
256
  USAGE
@@ -263,17 +263,17 @@ FLAGS
263
263
  -a, --app=<value> (required) app to run command against
264
264
 
265
265
  DESCRIPTION
266
- get the IP Rules for your MTLS enabled addon
266
+ get the IP Rules for your mTLS enabled add-on
267
267
 
268
268
  EXAMPLES
269
269
  $ heroku data:mtls:ip-rules postgresql-sushi-12345 -a example-app
270
270
  ```
271
271
 
272
- _See code: [src/commands/data/mtls/ip-rules/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/ip-rules/index.ts)_
272
+ _See code: [src/commands/data/mtls/ip-rules/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/ip-rules/index.ts)_
273
273
 
274
274
  ## `heroku data:mtls:ip-rules:create ADDON`
275
275
 
276
- create an IP Rule for your MTLS enabled addon
276
+ create a new IP Rule for your mTLS enabled add-on
277
277
 
278
278
  ```
279
279
  USAGE
@@ -288,17 +288,17 @@ FLAGS
288
288
  --description=<value>
289
289
 
290
290
  DESCRIPTION
291
- create an IP Rule for your MTLS enabled addon
291
+ create a new IP Rule for your mTLS enabled add-on
292
292
 
293
293
  EXAMPLES
294
294
  $ heroku data:mtls:ip-rules:create postgresql-sushi-12345 --cidr "1.2.3.4/32" --description "home IP address" -a example-app
295
295
  ```
296
296
 
297
- _See code: [src/commands/data/mtls/ip-rules/create.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/ip-rules/create.ts)_
297
+ _See code: [src/commands/data/mtls/ip-rules/create.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/ip-rules/create.ts)_
298
298
 
299
299
  ## `heroku data:mtls:ip-rules:delete ADDON`
300
300
 
301
- delete a specific IP Rule for your MTLS enabled addon
301
+ delete a specific IP Rule for your mTLS enabled add-on
302
302
 
303
303
  ```
304
304
  USAGE
@@ -313,17 +313,17 @@ FLAGS
313
313
  --id=<value> id of IP Rule
314
314
 
315
315
  DESCRIPTION
316
- delete a specific IP Rule for your MTLS enabled addon
316
+ delete a specific IP Rule for your mTLS enabled add-on
317
317
 
318
318
  EXAMPLES
319
319
  $ heroku data:mtls:ip-rules:delete postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app
320
320
  ```
321
321
 
322
- _See code: [src/commands/data/mtls/ip-rules/delete.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/ip-rules/delete.ts)_
322
+ _See code: [src/commands/data/mtls/ip-rules/delete.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/ip-rules/delete.ts)_
323
323
 
324
324
  ## `heroku data:mtls:ip-rules:get ADDON`
325
325
 
326
- get a specific IP Rule for your MTLS enabled addon
326
+ get the a specific IP Rule for your mTLS enabled add-on
327
327
 
328
328
  ```
329
329
  USAGE
@@ -337,11 +337,11 @@ FLAGS
337
337
  --id=<value> (required) id of IP Rule
338
338
 
339
339
  DESCRIPTION
340
- get a specific IP Rule for your MTLS enabled addon
340
+ get the a specific IP Rule for your mTLS enabled add-on
341
341
 
342
342
  EXAMPLES
343
343
  $ heroku data:mtls:ip-rules:get postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app
344
344
  ```
345
345
 
346
- _See code: [src/commands/data/mtls/ip-rules/get.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/ip-rules/get.ts)_
346
+ _See code: [src/commands/data/mtls/ip-rules/get.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/ip-rules/get.ts)_
347
347
  <!-- commandsstop -->
@@ -10,7 +10,7 @@ class MTLSCertificateCreate extends base_1.default {
10
10
  static args = {
11
11
  addon: core_1.Args.string({ required: true, description: 'addon' })
12
12
  };
13
- static description = 'create a new certificate for your MTLS enabled addon';
13
+ static description = 'create a new certificate for your mTLS enabled add-on';
14
14
  static examples = [
15
15
  '$ heroku data:mtls:certificates:create postgresql-sushi-12345 -a example-app'
16
16
  ];
@@ -21,7 +21,7 @@ class MTLSCertificateCreate extends base_1.default {
21
21
  const { args, flags } = await this.parse(MTLSCertificateCreate);
22
22
  const addon = await (0, fetcher_1.default)(this.heroku, args.addon, flags.app);
23
23
  if (addon.kind === 'kafka') {
24
- core_1.ux.error('Kafka certificates are availabe in your app\'s config vars');
24
+ core_1.ux.error('Kafka certificates are available in your app\'s config vars');
25
25
  }
26
26
  core_1.ux.action.start(`Creating new certificate for ${color_1.color.cyan(addon.name)}`);
27
27
  const { body: res } = await this.shogun.post(`${addon.endpoint}/certificates`, this.shogun.defaults);
@@ -10,7 +10,7 @@ class MTLSCertificateDelete extends base_1.default {
10
10
  static args = {
11
11
  addon: core_1.Args.string({ required: true, description: 'addon' })
12
12
  };
13
- static description = 'delete a specific certificate for your MTLS enabled addon';
13
+ static description = 'delete a specific certificate for your mTLS enabled add-on';
14
14
  static examples = [
15
15
  '$ heroku data:mtls:certificates:delete postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app'
16
16
  ];
@@ -22,7 +22,7 @@ class MTLSCertificateDelete extends base_1.default {
22
22
  const { args, flags } = await this.parse(MTLSCertificateDelete);
23
23
  const addon = await (0, fetcher_1.default)(this.heroku, args.addon, flags.app);
24
24
  if (addon.kind === 'kafka') {
25
- core_1.ux.error('Kafka certificates are availabe in your app\'s config vars');
25
+ core_1.ux.error('Kafka certificates are available in your app\'s config vars');
26
26
  }
27
27
  core_1.ux.action.start(`Deleting certificate for ${color_1.color.cyan(addon.name)}`);
28
28
  await this.shogun.delete(`${addon.endpoint}/certificates/${flags.id}`, this.shogun.defaults);
@@ -23,7 +23,7 @@ class MTLSCertificateDownload extends base_1.default {
23
23
  static args = {
24
24
  addon: core_1.Args.string({ required: true, description: 'addon' })
25
25
  };
26
- static description = 'download your certificate bundle for your mTLS addon';
26
+ static description = 'download your certificate bundle for your mTLS add-on';
27
27
  static examples = [
28
28
  '$ heroku data:mtls:certificates:download postgresql-sushi-12345 --id "3559a4df-2c82-4473-86cf-181310a6ef4f" -a example-app',
29
29
  '$ heroku data:mtls:certificates:download postgresql-sushi-12345 --id "3559a4df-2c82-4473-86cf-181310a6ef4f" --dir "./folder" -a example-app',
@@ -40,7 +40,7 @@ class MTLSCertificateDownload extends base_1.default {
40
40
  const { args, flags } = await this.parse(MTLSCertificateDownload);
41
41
  const addon = await (0, fetcher_1.default)(this.heroku, args.addon, flags.app);
42
42
  if (addon.kind === 'kafka') {
43
- core_1.ux.error('Kafka certificates are availabe in your app\'s config vars');
43
+ core_1.ux.error('Kafka certificates are available in your app\'s config vars');
44
44
  }
45
45
  core_1.ux.action.start(`Downloading certificates for ${color_1.color.cyan(addon.name)}`);
46
46
  const [{ body: mtls }, { body: certs }] = await Promise.all([
@@ -91,7 +91,7 @@ class MTLSCertificateDownload extends base_1.default {
91
91
  const root = `${path}/${flags.prefix}root.crt`;
92
92
  let download = true;
93
93
  if ((0, file_helper_1.existsSync)(root) || (0, file_helper_1.existsSync)(key) || (0, file_helper_1.existsSync)(crt)) {
94
- download = await core_1.ux.confirm('One of these files already exist. Would you like to overwrite them? (yes/no)');
94
+ download = await core_1.ux.confirm('One of these files already exists. Would you like to overwrite them? (yes/no)');
95
95
  }
96
96
  if (download) {
97
97
  await Promise.all([
@@ -109,7 +109,7 @@ class MTLSCertificateDownload extends base_1.default {
109
109
  }
110
110
  catch (err) {
111
111
  if ((0, is_error_http_1.isErrorHttp)(err) && err.http && err.http.statusCode === 404) {
112
- this.warn('mTLS is not setup yet for this addon');
112
+ this.warn('mTLS is not setup yet for this add-on');
113
113
  }
114
114
  else if ((0, is_error_message_1.isErrorMessage)(err)) {
115
115
  this.error(err.message);
@@ -9,7 +9,7 @@ class MTLSCertificateGet extends base_1.default {
9
9
  static args = {
10
10
  addon: core_1.Args.string({ required: true, description: 'addon' })
11
11
  };
12
- static description = 'get a specific certificate for your MTLS enabled addon';
12
+ static description = 'get a specific certificate for your mTLS enabled add-on';
13
13
  static examples = [
14
14
  '$ heroku data:mtls:certificates:get postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app'
15
15
  ];
@@ -21,7 +21,7 @@ class MTLSCertificateGet extends base_1.default {
21
21
  const { args, flags } = await this.parse(MTLSCertificateGet);
22
22
  const addon = await (0, fetcher_1.default)(this.heroku, args.addon, flags.app);
23
23
  if (addon.kind === 'kafka') {
24
- core_1.ux.error('Kafka certificates are availabe in your app\'s config vars');
24
+ core_1.ux.error('Kafka certificates are available in your app\'s config vars');
25
25
  }
26
26
  const { body: res } = await this.shogun.get(`${addon.endpoint}/certificates/${flags.id}`, this.shogun.defaults);
27
27
  delete res.private_key;
@@ -12,7 +12,7 @@ class MTLSCertificatesIndex extends base_1.default {
12
12
  static args = {
13
13
  addon: core_1.Args.string({ required: true, description: 'addon' })
14
14
  };
15
- static description = 'get the certificates for your MTLS enabled addon';
15
+ static description = 'get the certificates for your mTLS enabled add-on';
16
16
  static examples = [
17
17
  '$ heroku data:mtls:certificates postgresql-sushi-12345 -a example-app',
18
18
  ];
@@ -24,7 +24,7 @@ class MTLSCertificatesIndex extends base_1.default {
24
24
  const { args, flags } = await this.parse(MTLSCertificatesIndex);
25
25
  const addon = await (0, fetcher_1.default)(this.heroku, args.addon, flags.app);
26
26
  if (addon.kind === 'kafka') {
27
- core_1.ux.error('Kafka certificates are availabe in your app\'s config vars');
27
+ core_1.ux.error('Kafka certificates are available in your app\'s config vars');
28
28
  }
29
29
  const { body: res } = await this.shogun.get(`${addon.endpoint}/certificates`, this.shogun.defaults);
30
30
  if (res.length === 0) {
@@ -43,7 +43,7 @@ class MTLSCertificatesIndex extends base_1.default {
43
43
  this.error(err.message);
44
44
  }
45
45
  else {
46
- this.warn('mTLS is not setup yet for this addon');
46
+ this.warn('mTLS is not set up yet for this add-on');
47
47
  }
48
48
  }
49
49
  else {
@@ -11,7 +11,7 @@ class MTLSDestroy extends base_1.default {
11
11
  static args = {
12
12
  addon: core_1.Args.string({ required: true, description: 'addon' })
13
13
  };
14
- static description = 'destroy MTLS configuration on your addon';
14
+ static description = 'disable mTLS for your add-on';
15
15
  static examples = [
16
16
  '$ heroku data:mtls:destroy postgresql-sushi-12345 -a example-app'
17
17
  ];
@@ -13,7 +13,7 @@ class MTLSIndex extends base_1.default {
13
13
  static args = {
14
14
  addon: core_1.Args.string({ required: true, description: 'addon' })
15
15
  };
16
- static description = 'get the status of MTLS for your addon';
16
+ static description = 'get the status of mTLS for your add-on';
17
17
  static examples = [
18
18
  '$ heroku data:mtls postgresql-sushi-12345 -a example-app',
19
19
  ];
@@ -72,7 +72,7 @@ class MTLSIndex extends base_1.default {
72
72
  this.error(err.message);
73
73
  }
74
74
  else {
75
- this.warn('mTLS is not setup yet for this addon');
75
+ this.warn('mTLS is not set up yet for this add-on');
76
76
  }
77
77
  }
78
78
  else {
@@ -10,7 +10,7 @@ class MTLSIPCreate extends base_1.default {
10
10
  static args = {
11
11
  addon: core_1.Args.string({ required: true, description: 'addon' })
12
12
  };
13
- static description = 'create an IP Rule for your MTLS enabled addon';
13
+ static description = 'create a new IP Rule for your mTLS enabled add-on';
14
14
  static examples = [
15
15
  '$ heroku data:mtls:ip-rules:create postgresql-sushi-12345 --cidr "1.2.3.4/32" --description "home IP address" -a example-app'
16
16
  ];
@@ -10,7 +10,7 @@ class MTLSIPDelete extends base_1.default {
10
10
  static args = {
11
11
  addon: core_1.Args.string({ required: true, description: 'addon' })
12
12
  };
13
- static description = 'delete a specific IP Rule for your MTLS enabled addon';
13
+ static description = 'delete a specific IP Rule for your mTLS enabled add-on';
14
14
  static examples = [
15
15
  '$ heroku data:mtls:ip-rules:delete postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app'
16
16
  ];
@@ -22,7 +22,7 @@ class MTLSIPDelete extends base_1.default {
22
22
  async run() {
23
23
  const { args, flags } = await this.parse(MTLSIPDelete);
24
24
  if (!flags.cidr && !flags.id) {
25
- core_1.ux.error('You need at least pass in the id or cidr of the IP Rule');
25
+ core_1.ux.error('You need to provide the id or cidr of the IP Rule');
26
26
  }
27
27
  else {
28
28
  const addon = await (0, fetcher_1.default)(this.heroku, args.addon, flags.app);
@@ -9,7 +9,7 @@ class MTLSIPGet extends base_1.default {
9
9
  static args = {
10
10
  addon: core_1.Args.string({ required: true, description: 'addon' })
11
11
  };
12
- static description = 'get a specific IP Rule for your MTLS enabled addon';
12
+ static description = 'get the a specific IP Rule for your mTLS enabled add-on';
13
13
  static examples = [
14
14
  '$ heroku data:mtls:ip-rules:get postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app'
15
15
  ];
@@ -10,7 +10,7 @@ class MTLSIPIndex extends base_1.default {
10
10
  static args = {
11
11
  addon: core_1.Args.string({ required: true, description: 'addon' })
12
12
  };
13
- static description = 'get the IP Rules for your MTLS enabled addon';
13
+ static description = 'get the IP Rules for your mTLS enabled add-on';
14
14
  static examples = [
15
15
  '$ heroku data:mtls:ip-rules postgresql-sushi-12345 -a example-app',
16
16
  ];
@@ -22,7 +22,7 @@ class MTLSIPIndex extends base_1.default {
22
22
  const addon = await (0, fetcher_1.default)(this.heroku, args.addon, flags.app);
23
23
  const { body: res } = await this.shogun.get(`${addon.endpoint}/ip-rules`, this.shogun.defaults);
24
24
  if (res.length === 0) {
25
- core_1.ux.log('You currently have no IP Rules setup');
25
+ core_1.ux.log('You currently have no IP Rules set up');
26
26
  }
27
27
  else {
28
28
  (0, table_1.ipRulesTable)(res);
@@ -51,7 +51,7 @@
51
51
  "required": true
52
52
  }
53
53
  },
54
- "description": "destroy MTLS configuration on your addon",
54
+ "description": "disable mTLS for your add-on",
55
55
  "examples": [
56
56
  "$ heroku data:mtls:destroy postgresql-sushi-12345 -a example-app"
57
57
  ],
@@ -91,7 +91,7 @@
91
91
  "required": true
92
92
  }
93
93
  },
94
- "description": "get the status of MTLS for your addon",
94
+ "description": "get the status of mTLS for your add-on",
95
95
  "examples": [
96
96
  "$ heroku data:mtls postgresql-sushi-12345 -a example-app"
97
97
  ],
@@ -131,7 +131,7 @@
131
131
  "required": true
132
132
  }
133
133
  },
134
- "description": "create a new certificate for your MTLS enabled addon",
134
+ "description": "create a new certificate for your mTLS enabled add-on",
135
135
  "examples": [
136
136
  "$ heroku data:mtls:certificates:create postgresql-sushi-12345 -a example-app"
137
137
  ],
@@ -172,7 +172,7 @@
172
172
  "required": true
173
173
  }
174
174
  },
175
- "description": "delete a specific certificate for your MTLS enabled addon",
175
+ "description": "delete a specific certificate for your mTLS enabled add-on",
176
176
  "examples": [
177
177
  "$ heroku data:mtls:certificates:delete postgresql-sushi-12345 --id \"1862ec85-fdc1-47b3-924e-a91d26ca3a7c\" -a example-app"
178
178
  ],
@@ -221,7 +221,7 @@
221
221
  "required": true
222
222
  }
223
223
  },
224
- "description": "download your certificate bundle for your mTLS addon",
224
+ "description": "download your certificate bundle for your mTLS add-on",
225
225
  "examples": [
226
226
  "$ heroku data:mtls:certificates:download postgresql-sushi-12345 --id \"3559a4df-2c82-4473-86cf-181310a6ef4f\" -a example-app",
227
227
  "$ heroku data:mtls:certificates:download postgresql-sushi-12345 --id \"3559a4df-2c82-4473-86cf-181310a6ef4f\" --dir \"./folder\" -a example-app",
@@ -289,7 +289,7 @@
289
289
  "required": true
290
290
  }
291
291
  },
292
- "description": "get a specific certificate for your MTLS enabled addon",
292
+ "description": "get a specific certificate for your mTLS enabled add-on",
293
293
  "examples": [
294
294
  "$ heroku data:mtls:certificates:get postgresql-sushi-12345 --id \"1862ec85-fdc1-47b3-924e-a91d26ca3a7c\" -a example-app"
295
295
  ],
@@ -338,7 +338,7 @@
338
338
  "required": true
339
339
  }
340
340
  },
341
- "description": "get the certificates for your MTLS enabled addon",
341
+ "description": "get the certificates for your mTLS enabled add-on",
342
342
  "examples": [
343
343
  "$ heroku data:mtls:certificates postgresql-sushi-12345 -a example-app"
344
344
  ],
@@ -379,7 +379,7 @@
379
379
  "required": true
380
380
  }
381
381
  },
382
- "description": "create an IP Rule for your MTLS enabled addon",
382
+ "description": "create a new IP Rule for your mTLS enabled add-on",
383
383
  "examples": [
384
384
  "$ heroku data:mtls:ip-rules:create postgresql-sushi-12345 --cidr \"1.2.3.4/32\" --description \"home IP address\" -a example-app"
385
385
  ],
@@ -434,7 +434,7 @@
434
434
  "required": true
435
435
  }
436
436
  },
437
- "description": "delete a specific IP Rule for your MTLS enabled addon",
437
+ "description": "delete a specific IP Rule for your mTLS enabled add-on",
438
438
  "examples": [
439
439
  "$ heroku data:mtls:ip-rules:delete postgresql-sushi-12345 --id \"1862ec85-fdc1-47b3-924e-a91d26ca3a7c\" -a example-app"
440
440
  ],
@@ -489,7 +489,7 @@
489
489
  "required": true
490
490
  }
491
491
  },
492
- "description": "get a specific IP Rule for your MTLS enabled addon",
492
+ "description": "get the a specific IP Rule for your mTLS enabled add-on",
493
493
  "examples": [
494
494
  "$ heroku data:mtls:ip-rules:get postgresql-sushi-12345 --id \"1862ec85-fdc1-47b3-924e-a91d26ca3a7c\" -a example-app"
495
495
  ],
@@ -538,7 +538,7 @@
538
538
  "required": true
539
539
  }
540
540
  },
541
- "description": "get the IP Rules for your MTLS enabled addon",
541
+ "description": "get the IP Rules for your mTLS enabled add-on",
542
542
  "examples": [
543
543
  "$ heroku data:mtls:ip-rules postgresql-sushi-12345 -a example-app"
544
544
  ],
@@ -571,5 +571,5 @@
571
571
  ]
572
572
  }
573
573
  },
574
- "version": "1.0.1"
574
+ "version": "1.0.2"
575
575
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@heroku-cli/plugin-mtls",
3
3
  "description": "heroku mtls cli",
4
- "version": "1.0.1",
4
+ "version": "1.0.2",
5
5
  "author": "Heroku",
6
6
  "bugs": "https://github.com/heroku/heroku-cli-plugin-mtls/issues",
7
7
  "dependencies": {
@@ -25,6 +25,8 @@
25
25
  "@typescript-eslint/eslint-plugin": "^6.14.0",
26
26
  "@typescript-eslint/parser": "6.x",
27
27
  "chai": "^4",
28
+ "conventional-changelog": "^7.1.1",
29
+ "conventional-changelog-conventionalcommits": "^9.1.0",
28
30
  "eslint": "8.x",
29
31
  "eslint-config-oclif": "^5.0.0",
30
32
  "eslint-config-oclif-typescript": "^3.0.26",
@@ -33,6 +35,7 @@
33
35
  "np": "^10.2.0",
34
36
  "nyc": "^17.1.0",
35
37
  "oclif": "^4.14.36",
38
+ "shx": "^0.3.3",
36
39
  "sinon": "^19",
37
40
  "ts-node": "10.x",
38
41
  "typescript": "^5"
@@ -41,7 +44,8 @@
41
44
  "node": ">= 20.x"
42
45
  },
43
46
  "files": [
44
- "/dist"
47
+ "/dist",
48
+ "oclif.manifest.json"
45
49
  ],
46
50
  "homepage": "https://github.com/heroku/heroku-cli-plugin-mtls",
47
51
  "keywords": [
@@ -58,13 +62,15 @@
58
62
  },
59
63
  "repository": "heroku/heroku-cli-plugin-mtls",
60
64
  "scripts": {
65
+ "build": "shx rm -rf dist && tsc -b",
66
+ "changelog": "conventional-changelog -p conventionalcommits -s -i CHANGELOG.md",
61
67
  "lint": "eslint . --ext .ts --config .eslintrc",
62
68
  "lint:fix": "yarn run lint -- --fix",
63
- "posttest": "yarn run lint",
64
- "prepack": "yarn run build",
65
- "build": "rm -rf dist && tsc -b && oclif manifest && oclif readme && mv oclif.manifest.json ./dist/oclif.manifest.json && cp README.md ./dist/README.md",
69
+ "postpack": "shx rm -f oclif.manifest.json",
70
+ "posttest": "yarn lint",
71
+ "prepack": "yarn build && oclif manifest && oclif readme",
66
72
  "test": "nyc --extension .ts mocha --config test/mocharc.json --forbid-only \"test/**/*.test.ts\"",
67
- "test:local": "nyc --extension .ts mocha --config test/mocharc.json \"test/**/*.test.ts\"",
73
+ "test:local": "mocha --config test/mocharc.json \"test/**/*.test.ts\"",
68
74
  "version": "oclif readme && git add README.md"
69
75
  }
70
76
  }
package/dist/README.md DELETED
@@ -1,347 +0,0 @@
1
- # Heroku CLI MTLS Plugin
2
-
3
- [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
4
- ![GitHub Actions CI](https://github.com/heroku/heroku-mtls-cli/actions/workflows/ci.yml/badge.svg)
5
-
6
- <!-- toc -->
7
- * [Heroku CLI MTLS Plugin](#heroku-cli-mtls-plugin)
8
- * [Installation](#installation)
9
- * [Commands](#commands)
10
- <!-- tocstop -->
11
- # Installation
12
- ```sh-session
13
- $ heroku plugins:install @heroku-cli/plugin-mtls
14
- ```
15
- # Commands
16
- <!-- commands -->
17
- * [`heroku data:mtls ADDON`](#heroku-datamtls-addon)
18
- * [`heroku data:mtls:certificates ADDON`](#heroku-datamtlscertificates-addon)
19
- * [`heroku data:mtls:certificates:create ADDON`](#heroku-datamtlscertificatescreate-addon)
20
- * [`heroku data:mtls:certificates:delete ADDON`](#heroku-datamtlscertificatesdelete-addon)
21
- * [`heroku data:mtls:certificates:download ADDON`](#heroku-datamtlscertificatesdownload-addon)
22
- * [`heroku data:mtls:certificates:get ADDON`](#heroku-datamtlscertificatesget-addon)
23
- * [`heroku data:mtls:create ADDON`](#heroku-datamtlscreate-addon)
24
- * [`heroku data:mtls:delete ADDON`](#heroku-datamtlsdelete-addon)
25
- * [`heroku data:mtls:destroy ADDON`](#heroku-datamtlsdestroy-addon)
26
- * [`heroku data:mtls:ip-rules ADDON`](#heroku-datamtlsip-rules-addon)
27
- * [`heroku data:mtls:ip-rules:create ADDON`](#heroku-datamtlsip-rulescreate-addon)
28
- * [`heroku data:mtls:ip-rules:delete ADDON`](#heroku-datamtlsip-rulesdelete-addon)
29
- * [`heroku data:mtls:ip-rules:get ADDON`](#heroku-datamtlsip-rulesget-addon)
30
-
31
- ## `heroku data:mtls ADDON`
32
-
33
- get the status of MTLS for your addon
34
-
35
- ```
36
- USAGE
37
- $ heroku data:mtls ADDON -a <value>
38
-
39
- ARGUMENTS
40
- ADDON addon
41
-
42
- FLAGS
43
- -a, --app=<value> (required) app to run command against
44
-
45
- DESCRIPTION
46
- get the status of MTLS for your addon
47
-
48
- EXAMPLES
49
- $ heroku data:mtls postgresql-sushi-12345 -a example-app
50
- ```
51
-
52
- _See code: [src/commands/data/mtls/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/index.ts)_
53
-
54
- ## `heroku data:mtls:certificates ADDON`
55
-
56
- get the certificates for your MTLS enabled addon
57
-
58
- ```
59
- USAGE
60
- $ heroku data:mtls:certificates ADDON -a <value>
61
-
62
- ARGUMENTS
63
- ADDON addon
64
-
65
- FLAGS
66
- -a, --app=<value> (required) app to run command against
67
-
68
- DESCRIPTION
69
- get the certificates for your MTLS enabled addon
70
-
71
- EXAMPLES
72
- $ heroku data:mtls:certificates postgresql-sushi-12345 -a example-app
73
- ```
74
-
75
- _See code: [src/commands/data/mtls/certificates/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/certificates/index.ts)_
76
-
77
- ## `heroku data:mtls:certificates:create ADDON`
78
-
79
- create a new certificate for your MTLS enabled addon
80
-
81
- ```
82
- USAGE
83
- $ heroku data:mtls:certificates:create ADDON -a <value>
84
-
85
- ARGUMENTS
86
- ADDON addon
87
-
88
- FLAGS
89
- -a, --app=<value> (required) app to run command against
90
-
91
- DESCRIPTION
92
- create a new certificate for your MTLS enabled addon
93
-
94
- EXAMPLES
95
- $ heroku data:mtls:certificates:create postgresql-sushi-12345 -a example-app
96
- ```
97
-
98
- _See code: [src/commands/data/mtls/certificates/create.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/certificates/create.ts)_
99
-
100
- ## `heroku data:mtls:certificates:delete ADDON`
101
-
102
- delete a specific certificate for your MTLS enabled addon
103
-
104
- ```
105
- USAGE
106
- $ heroku data:mtls:certificates:delete ADDON -a <value> --id <value>
107
-
108
- ARGUMENTS
109
- ADDON addon
110
-
111
- FLAGS
112
- -a, --app=<value> (required) app to run command against
113
- --id=<value> (required) id of certificate
114
-
115
- DESCRIPTION
116
- delete a specific certificate for your MTLS enabled addon
117
-
118
- EXAMPLES
119
- $ heroku data:mtls:certificates:delete postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app
120
- ```
121
-
122
- _See code: [src/commands/data/mtls/certificates/delete.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/certificates/delete.ts)_
123
-
124
- ## `heroku data:mtls:certificates:download ADDON`
125
-
126
- download your certificate bundle for your mTLS addon
127
-
128
- ```
129
- USAGE
130
- $ heroku data:mtls:certificates:download ADDON -a <value> --prefix <value> [--dir <value>] [--id <value>]
131
-
132
- ARGUMENTS
133
- ADDON addon
134
-
135
- FLAGS
136
- -a, --app=<value> (required) app to run command against
137
- --dir=<value> directory to download files to. defaults to HOME:/.postgresql
138
- --id=<value> ID of certificate to download
139
- --prefix=<value> (required) prefix to put in front of downloaded file names
140
-
141
- DESCRIPTION
142
- download your certificate bundle for your mTLS addon
143
-
144
- EXAMPLES
145
- $ heroku data:mtls:certificates:download postgresql-sushi-12345 --id "3559a4df-2c82-4473-86cf-181310a6ef4f" -a example-app
146
-
147
- $ heroku data:mtls:certificates:download postgresql-sushi-12345 --id "3559a4df-2c82-4473-86cf-181310a6ef4f" --dir "./folder" -a example-app
148
-
149
- $ heroku data:mtls:certificates:download postgresql-sushi-12345 --id "3559a4df-2c82-4473-86cf-181310a6ef4f --prefix "prefix_" -a example-app
150
- ```
151
-
152
- _See code: [src/commands/data/mtls/certificates/download.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/certificates/download.ts)_
153
-
154
- ## `heroku data:mtls:certificates:get ADDON`
155
-
156
- get a specific certificate for your MTLS enabled addon
157
-
158
- ```
159
- USAGE
160
- $ heroku data:mtls:certificates:get ADDON -a <value> --id <value>
161
-
162
- ARGUMENTS
163
- ADDON addon
164
-
165
- FLAGS
166
- -a, --app=<value> (required) app to run command against
167
- --id=<value> (required) id of IP Rule
168
-
169
- DESCRIPTION
170
- get a specific certificate for your MTLS enabled addon
171
-
172
- EXAMPLES
173
- $ heroku data:mtls:certificates:get postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app
174
- ```
175
-
176
- _See code: [src/commands/data/mtls/certificates/get.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/certificates/get.ts)_
177
-
178
- ## `heroku data:mtls:create ADDON`
179
-
180
- enable MTLS for your addon
181
-
182
- ```
183
- USAGE
184
- $ heroku data:mtls:create ADDON -a <value>
185
-
186
- ARGUMENTS
187
- ADDON addon
188
-
189
- FLAGS
190
- -a, --app=<value> (required) app to run command against
191
-
192
- DESCRIPTION
193
- enable MTLS for your addon
194
-
195
- EXAMPLES
196
- $ heroku data:mtls:create postgresql-sushi-12345 -a example-app
197
- ```
198
-
199
- _See code: [src/commands/data/mtls/create.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/create.ts)_
200
-
201
- ## `heroku data:mtls:delete ADDON`
202
-
203
- destroy MTLS configuration on your addon
204
-
205
- ```
206
- USAGE
207
- $ heroku data:mtls:delete ADDON -a <value>
208
-
209
- ARGUMENTS
210
- ADDON addon
211
-
212
- FLAGS
213
- -a, --app=<value> (required) app to run command against
214
-
215
- DESCRIPTION
216
- destroy MTLS configuration on your addon
217
-
218
- ALIASES
219
- $ heroku data:mtls:delete
220
-
221
- EXAMPLES
222
- $ heroku data:mtls:destroy postgresql-sushi-12345 -a example-app
223
- ```
224
-
225
- ## `heroku data:mtls:destroy ADDON`
226
-
227
- destroy MTLS configuration on your addon
228
-
229
- ```
230
- USAGE
231
- $ heroku data:mtls:destroy ADDON -a <value>
232
-
233
- ARGUMENTS
234
- ADDON addon
235
-
236
- FLAGS
237
- -a, --app=<value> (required) app to run command against
238
-
239
- DESCRIPTION
240
- destroy MTLS configuration on your addon
241
-
242
- ALIASES
243
- $ heroku data:mtls:delete
244
-
245
- EXAMPLES
246
- $ heroku data:mtls:destroy postgresql-sushi-12345 -a example-app
247
- ```
248
-
249
- _See code: [src/commands/data/mtls/destroy.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/destroy.ts)_
250
-
251
- ## `heroku data:mtls:ip-rules ADDON`
252
-
253
- get the IP Rules for your MTLS enabled addon
254
-
255
- ```
256
- USAGE
257
- $ heroku data:mtls:ip-rules ADDON -a <value>
258
-
259
- ARGUMENTS
260
- ADDON addon
261
-
262
- FLAGS
263
- -a, --app=<value> (required) app to run command against
264
-
265
- DESCRIPTION
266
- get the IP Rules for your MTLS enabled addon
267
-
268
- EXAMPLES
269
- $ heroku data:mtls:ip-rules postgresql-sushi-12345 -a example-app
270
- ```
271
-
272
- _See code: [src/commands/data/mtls/ip-rules/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/ip-rules/index.ts)_
273
-
274
- ## `heroku data:mtls:ip-rules:create ADDON`
275
-
276
- create an IP Rule for your MTLS enabled addon
277
-
278
- ```
279
- USAGE
280
- $ heroku data:mtls:ip-rules:create ADDON -a <value> --cidr <value> [--description <value>]
281
-
282
- ARGUMENTS
283
- ADDON addon
284
-
285
- FLAGS
286
- -a, --app=<value> (required) app to run command against
287
- --cidr=<value> (required)
288
- --description=<value>
289
-
290
- DESCRIPTION
291
- create an IP Rule for your MTLS enabled addon
292
-
293
- EXAMPLES
294
- $ heroku data:mtls:ip-rules:create postgresql-sushi-12345 --cidr "1.2.3.4/32" --description "home IP address" -a example-app
295
- ```
296
-
297
- _See code: [src/commands/data/mtls/ip-rules/create.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/ip-rules/create.ts)_
298
-
299
- ## `heroku data:mtls:ip-rules:delete ADDON`
300
-
301
- delete a specific IP Rule for your MTLS enabled addon
302
-
303
- ```
304
- USAGE
305
- $ heroku data:mtls:ip-rules:delete ADDON -a <value> [--cidr <value>] [--id <value>]
306
-
307
- ARGUMENTS
308
- ADDON addon
309
-
310
- FLAGS
311
- -a, --app=<value> (required) app to run command against
312
- --cidr=<value> cidr of IP Rule
313
- --id=<value> id of IP Rule
314
-
315
- DESCRIPTION
316
- delete a specific IP Rule for your MTLS enabled addon
317
-
318
- EXAMPLES
319
- $ heroku data:mtls:ip-rules:delete postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app
320
- ```
321
-
322
- _See code: [src/commands/data/mtls/ip-rules/delete.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/ip-rules/delete.ts)_
323
-
324
- ## `heroku data:mtls:ip-rules:get ADDON`
325
-
326
- get a specific IP Rule for your MTLS enabled addon
327
-
328
- ```
329
- USAGE
330
- $ heroku data:mtls:ip-rules:get ADDON -a <value> --id <value>
331
-
332
- ARGUMENTS
333
- ADDON addon
334
-
335
- FLAGS
336
- -a, --app=<value> (required) app to run command against
337
- --id=<value> (required) id of IP Rule
338
-
339
- DESCRIPTION
340
- get a specific IP Rule for your MTLS enabled addon
341
-
342
- EXAMPLES
343
- $ heroku data:mtls:ip-rules:get postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app
344
- ```
345
-
346
- _See code: [src/commands/data/mtls/ip-rules/get.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.1/src/commands/data/mtls/ip-rules/get.ts)_
347
- <!-- commandsstop -->