@codiac.io/codiac-cli 1.2.156 → 1.2.157
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/README.md +5 -3753
- package/oclif.manifest.json +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -9,3777 +9,29 @@ oclif example Hello World CLI
|
|
|
9
9
|
[](https://github.com/oclif/hello-world/blob/main/package.json)
|
|
10
10
|
|
|
11
11
|
<!-- toc -->
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
<!-- tocstop -->
|
|
12
|
+
* [Codiac-CLI](#codiac-cli)
|
|
13
|
+
* [Usage](#usage)
|
|
14
|
+
* [Commands](#commands)
|
|
15
|
+
<!-- tocstop -->
|
|
17
16
|
|
|
18
17
|
# Usage
|
|
19
18
|
|
|
20
19
|
<!-- usage -->
|
|
21
|
-
|
|
22
20
|
```sh-session
|
|
23
21
|
$ npm install -g @codiac.io/codiac-cli
|
|
24
22
|
$ codiac COMMAND
|
|
25
23
|
running command...
|
|
26
24
|
$ codiac (-v|--version|version)
|
|
27
|
-
@codiac.io/codiac-cli/1.2.
|
|
25
|
+
@codiac.io/codiac-cli/1.2.157 linux-x64 node-v12.22.12
|
|
28
26
|
$ codiac --help [COMMAND]
|
|
29
27
|
USAGE
|
|
30
28
|
$ codiac COMMAND
|
|
31
29
|
...
|
|
32
30
|
```
|
|
33
|
-
|
|
34
31
|
<!-- usagestop -->
|
|
35
32
|
|
|
36
33
|
# Commands
|
|
37
34
|
|
|
38
35
|
<!-- commands -->
|
|
39
36
|
|
|
40
|
-
- [`codiac asset:create`](#codiac-assetcreate)
|
|
41
|
-
- [`codiac asset:destroy`](#codiac-assetdestroy)
|
|
42
|
-
- [`codiac asset:helm [SETTING]`](#codiac-assethelm-setting)
|
|
43
|
-
- [`codiac asset:list`](#codiac-assetlist)
|
|
44
|
-
- [`codiac asset:probe:create [CMD]`](#codiac-assetprobecreate-cmd)
|
|
45
|
-
- [`codiac asset:recycle`](#codiac-assetrecycle)
|
|
46
|
-
- [`codiac asset:view [CMD]`](#codiac-assetview-cmd)
|
|
47
|
-
- [`codiac asset:volume:create [MOUNTPATH]`](#codiac-assetvolumecreate-mountpath)
|
|
48
|
-
- [`codiac asset:volume:delete`](#codiac-assetvolumedelete)
|
|
49
|
-
- [`codiac asset:volume:list`](#codiac-assetvolumelist)
|
|
50
|
-
- [`codiac autocomplete [SHELL]`](#codiac-autocomplete-shell)
|
|
51
|
-
- [`codiac branch [NAME]`](#codiac-branch-name)
|
|
52
|
-
- [`codiac branch:current`](#codiac-branchcurrent)
|
|
53
|
-
- [`codiac branch:list`](#codiac-branchlist)
|
|
54
|
-
- [`codiac build`](#codiac-build)
|
|
55
|
-
- [`codiac cabinet:create [CABINET]`](#codiac-cabinetcreate-cabinet)
|
|
56
|
-
- [`codiac cabinet:list`](#codiac-cabinetlist)
|
|
57
|
-
- [`codiac cabinet:obliterate [CABINET]`](#codiac-cabinetobliterate-cabinet)
|
|
58
|
-
- [`codiac cli`](#codiac-cli)
|
|
59
|
-
- [`codiac commit [MESSAGE]`](#codiac-commit-message)
|
|
60
|
-
- [`codiac config:add [SETTING]`](#codiac-configadd-setting)
|
|
61
|
-
- [`codiac config:delete [SETTING]`](#codiac-configdelete-setting)
|
|
62
|
-
- [`codiac config:deploy`](#codiac-configdeploy)
|
|
63
|
-
- [`codiac config:import [SETTING]`](#codiac-configimport-setting)
|
|
64
|
-
- [`codiac config:view [SETTING]`](#codiac-configview-setting)
|
|
65
|
-
- [`codiac dep [NAME]`](#codiac-dep-name)
|
|
66
|
-
- [`codiac dep:create [URL]`](#codiac-depcreate-url)
|
|
67
|
-
- [`codiac dep:install`](#codiac-depinstall)
|
|
68
|
-
- [`codiac dep:list`](#codiac-deplist)
|
|
69
|
-
- [`codiac dep:remove [NAME]`](#codiac-depremove-name)
|
|
70
|
-
- [`codiac dep:source [NAME]`](#codiac-depsource-name)
|
|
71
|
-
- [`codiac dep:syncup [DEPENDENCY]`](#codiac-depsyncup-dependency)
|
|
72
|
-
- [`codiac dep:unsource [NAME]`](#codiac-depunsource-name)
|
|
73
|
-
- [`codiac dep:upgrade [DEPENDENCY]`](#codiac-depupgrade-dependency)
|
|
74
|
-
- [`codiac deploy`](#codiac-deploy)
|
|
75
|
-
- [`codiac enterprise:create [CODE]`](#codiac-enterprisecreate-code)
|
|
76
|
-
- [`codiac enterprise:list`](#codiac-enterpriselist)
|
|
77
|
-
- [`codiac env:add [SETTING]`](#codiac-envadd-setting)
|
|
78
|
-
- [`codiac environment:create [NAME]`](#codiac-environmentcreate-name)
|
|
79
|
-
- [`codiac environment:list`](#codiac-environmentlist)
|
|
80
|
-
- [`codiac filestore:capture`](#codiac-filestorecapture)
|
|
81
|
-
- [`codiac help [COMMAND]`](#codiac-help-command)
|
|
82
|
-
- [`codiac host:map [DOMAIN]`](#codiac-hostmap-domain)
|
|
83
|
-
- [`codiac identity [TOKENNAME]`](#codiac-identity-tokenname)
|
|
84
|
-
- [`codiac identity:delete [NAME]`](#codiac-identitydelete-name)
|
|
85
|
-
- [`codiac identity:list`](#codiac-identitylist)
|
|
86
|
-
- [`codiac imageRegistry:capture`](#codiac-imageregistrycapture)
|
|
87
|
-
- [`codiac imageRegistry:forget`](#codiac-imageregistryforget)
|
|
88
|
-
- [`codiac imageRegistry:pullSecret:set`](#codiac-imageregistrypullsecretset)
|
|
89
|
-
- [`codiac imageRegistry:pullSecret:unset`](#codiac-imageregistrypullsecretunset)
|
|
90
|
-
- [`codiac images:add [IMAGENAME]`](#codiac-imagesadd-imagename)
|
|
91
|
-
- [`codiac images:list [HELLO]`](#codiac-imageslist-hello)
|
|
92
|
-
- [`codiac images:patch IMAGENAME`](#codiac-imagespatch-imagename)
|
|
93
|
-
- [`codiac images:remove IMAGENAME`](#codiac-imagesremove-imagename)
|
|
94
|
-
- [`codiac images:version [NAME]`](#codiac-imagesversion-name)
|
|
95
|
-
- [`codiac init DIRECTORY`](#codiac-init-directory)
|
|
96
|
-
- [`codiac kit:create [SETTING]`](#codiac-kitcreate-setting)
|
|
97
|
-
- [`codiac login`](#codiac-login)
|
|
98
|
-
- [`codiac logout`](#codiac-logout)
|
|
99
|
-
- [`codiac merge [BRANCH]`](#codiac-merge-branch)
|
|
100
|
-
- [`codiac noc:cluster:create [NAME]`](#codiac-nocclustercreate-name)
|
|
101
|
-
- [`codiac noc:cluster:deinit [NAME]`](#codiac-nocclusterdeinit-name)
|
|
102
|
-
- [`codiac noc:cluster:destroy [NAME]`](#codiac-nocclusterdestroy-name)
|
|
103
|
-
- [`codiac noc:cluster:init [NAME]`](#codiac-nocclusterinit-name)
|
|
104
|
-
- [`codiac noc:cluster:list`](#codiac-nocclusterlist)
|
|
105
|
-
- [`codiac noc:cluster:recreate [NAME]`](#codiac-nocclusterrecreate-name)
|
|
106
|
-
- [`codiac pkg:add [DEFINITIONFILE]`](#codiac-pkgadd-definitionfile)
|
|
107
|
-
- [`codiac pkg:list [HELLO]`](#codiac-pkglist-hello)
|
|
108
|
-
- [`codiac pkg:patch PACKAGENAME`](#codiac-pkgpatch-packagename)
|
|
109
|
-
- [`codiac pkg:remove [PACKAGENAME]`](#codiac-pkgremove-packagename)
|
|
110
|
-
- [`codiac portal`](#codiac-portal)
|
|
111
|
-
- [`codiac publish [NAME]`](#codiac-publish-name)
|
|
112
|
-
- [`codiac pull [NAME]`](#codiac-pull-name)
|
|
113
|
-
- [`codiac push [NAME]`](#codiac-push-name)
|
|
114
|
-
- [`codiac run`](#codiac-run)
|
|
115
|
-
- [`codiac secretStore:capture`](#codiac-secretstorecapture)
|
|
116
|
-
- [`codiac secretStore:forget`](#codiac-secretstoreforget)
|
|
117
|
-
- [`codiac stage [FILES]`](#codiac-stage-files)
|
|
118
|
-
- [`codiac stash [FILE]`](#codiac-stash-file)
|
|
119
|
-
- [`codiac status`](#codiac-status)
|
|
120
|
-
- [`codiac stop`](#codiac-stop)
|
|
121
|
-
- [`codiac switch [NAME]`](#codiac-switch-name)
|
|
122
|
-
- [`codiac sync [NAME]`](#codiac-sync-name)
|
|
123
|
-
- [`codiac tenant:create [NAME]`](#codiac-tenantcreate-name)
|
|
124
|
-
- [`codiac tenant:switch [NAME]`](#codiac-tenantswitch-name)
|
|
125
|
-
- [`codiac unstage [FILES]`](#codiac-unstage-files)
|
|
126
|
-
- [`codiac update [CHANNEL]`](#codiac-update-channel)
|
|
127
|
-
- [`codiac version`](#codiac-version)
|
|
128
|
-
- [`codiac whereami [FILE]`](#codiac-whereami-file)
|
|
129
|
-
- [`codiac whoami`](#codiac-whoami)
|
|
130
|
-
|
|
131
|
-
## `codiac asset:create`
|
|
132
|
-
|
|
133
|
-
Creates a new asset in the given enterprise from an image that exists in a container registry.
|
|
134
|
-
|
|
135
|
-
```
|
|
136
|
-
USAGE
|
|
137
|
-
$ codiac asset:create
|
|
138
|
-
|
|
139
|
-
OPTIONS
|
|
140
|
-
-c, --code=code The host name to assign this asset in the domain url. eg: 'myasset' in
|
|
141
|
-
'myasset.your-domain.com' (Optional: defaults to the asset name).
|
|
142
|
-
|
|
143
|
-
-e, --enterprise=enterprise The name of the enterprise in which to create this asset. (defaults to the current
|
|
144
|
-
enterprise context)
|
|
145
|
-
|
|
146
|
-
-g, --hasIngress Declaration that the asset service is to be externally accessible (optional: defaults to
|
|
147
|
-
false).
|
|
148
|
-
|
|
149
|
-
-h, --help Show CLI help.
|
|
150
|
-
|
|
151
|
-
-i, --image=image The image name including scope prefix if applicable (eg: '@yourCompany/your-api-image').
|
|
152
|
-
|
|
153
|
-
-k, --kit=kit The name of the kit (with library prefix, eg: 'library/kitName') to use to create the
|
|
154
|
-
asset. Use '?' to be prompted for a kit (Optional: used instead of calling for the
|
|
155
|
-
image).
|
|
156
|
-
|
|
157
|
-
-n, --name=name The name to give the enterprise asset (Optional: defaults to the image name without the
|
|
158
|
-
scope prefix).
|
|
159
|
-
|
|
160
|
-
-o, --routedWithoutName Indicates that this asset will be the base ingress against your DNS. eg: true services
|
|
161
|
-
yourwebsite.com (as root/naked) (optional: defaults to false).
|
|
162
|
-
|
|
163
|
-
-p, --port=port The default port to assign the asset when deployed to a cabinet (optional).
|
|
164
|
-
|
|
165
|
-
-r, --registry=registry The container registry in which the image exists (defaults to docker hub).
|
|
166
|
-
|
|
167
|
-
-t, --toScript Outputs an assembled command string, NO execution
|
|
168
|
-
|
|
169
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
170
|
-
|
|
171
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered
|
|
172
|
-
from prior runs. Requires: image,registry,name,code,enterprise,port
|
|
173
|
-
|
|
174
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
175
|
-
--rememberAs flag.
|
|
176
|
-
|
|
177
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
178
|
-
|
|
179
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
180
|
-
|
|
181
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that
|
|
182
|
-
were previously stored under the given name (use "--unRemember default" to clear default
|
|
183
|
-
argument list memorized with the --remember flag).
|
|
184
|
-
|
|
185
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
186
|
-
|
|
187
|
-
ALIASES
|
|
188
|
-
$ codiac asset:new
|
|
189
|
-
```
|
|
190
|
-
|
|
191
|
-
_See code: [src/commands/asset/create.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/asset/create.ts)_
|
|
192
|
-
|
|
193
|
-
## `codiac asset:destroy`
|
|
194
|
-
|
|
195
|
-
UN-deploys a given asset from a given cabinet. Defaults to removing only the pod deployments and leaving the service in place; set the --scorch argument to remove the service.
|
|
196
|
-
|
|
197
|
-
```
|
|
198
|
-
USAGE
|
|
199
|
-
$ codiac asset:destroy
|
|
200
|
-
|
|
201
|
-
OPTIONS
|
|
202
|
-
-a, --asset=asset Search string for the name of the asset to destroy (use ? to be prompted).
|
|
203
|
-
-h, --help Show CLI help.
|
|
204
|
-
|
|
205
|
-
-s, --scorch (Optional: defaults to false) Destroys the service too, instead of just the deployment and
|
|
206
|
-
pods.
|
|
207
|
-
|
|
208
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
209
|
-
|
|
210
|
-
-v, --version=version Search string for the version of the asset to destroy (use ? to be prompted).
|
|
211
|
-
|
|
212
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
|
|
213
|
-
prior runs.
|
|
214
|
-
|
|
215
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
216
|
-
--rememberAs flag.
|
|
217
|
-
|
|
218
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
219
|
-
|
|
220
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
221
|
-
|
|
222
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
223
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
224
|
-
list memorized with the --remember flag).
|
|
225
|
-
|
|
226
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
227
|
-
```
|
|
228
|
-
|
|
229
|
-
_See code: [src/commands/asset/destroy.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/asset/destroy.ts)_
|
|
230
|
-
|
|
231
|
-
## `codiac asset:helm [SETTING]`
|
|
232
|
-
|
|
233
|
-
Creates a new asset in the given enterprise from an image that exists in a container registry.
|
|
234
|
-
|
|
235
|
-
```
|
|
236
|
-
USAGE
|
|
237
|
-
$ codiac asset:helm [SETTING]
|
|
238
|
-
|
|
239
|
-
ARGUMENTS
|
|
240
|
-
SETTING The key for the config setting to add
|
|
241
|
-
|
|
242
|
-
OPTIONS
|
|
243
|
-
-c, --code=code The host name to assign this asset in the domain url. eg: 'myasset' in
|
|
244
|
-
'myasset.your-domain.com' (Optional: defaults to the asset name).
|
|
245
|
-
|
|
246
|
-
-e, --enterprise=enterprise The name of the enterprise in which to create this asset. (defaults to the current
|
|
247
|
-
enterprise context)
|
|
248
|
-
|
|
249
|
-
-g, --hasIngress Declaration that the asset service is to be externally accessible (optional: defaults to
|
|
250
|
-
false).
|
|
251
|
-
|
|
252
|
-
-h, --help Show CLI help.
|
|
253
|
-
|
|
254
|
-
-i, --chart=chart The chart name including scope prefix if applicable (eg: '@yourCompany/your-helm-chart').
|
|
255
|
-
|
|
256
|
-
-n, --name=name The name to give the enterprise asset (Optional: defaults to the image name without the
|
|
257
|
-
scope prefix).
|
|
258
|
-
|
|
259
|
-
-o, --routedWithoutName Indicates that this asset will be the base ingress against your DNS. eg: true services
|
|
260
|
-
yourwebsite.com (as root/naked) (optional: defaults to false).
|
|
261
|
-
|
|
262
|
-
-p, --port=port The default port to assign the asset when deployed to a cabinet (optional).
|
|
263
|
-
|
|
264
|
-
-r, --registry=registry The chart registry in which the chart exists (defaults to docker hub).
|
|
265
|
-
|
|
266
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
267
|
-
|
|
268
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered
|
|
269
|
-
from prior runs. Requires:
|
|
270
|
-
image,registry,name,code,enterprise,port,hasIngress,routedWithoutName
|
|
271
|
-
|
|
272
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
273
|
-
--rememberAs flag.
|
|
274
|
-
|
|
275
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
276
|
-
|
|
277
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
278
|
-
|
|
279
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that
|
|
280
|
-
were previously stored under the given name (use "--unRemember default" to clear default
|
|
281
|
-
argument list memorized with the --remember flag).
|
|
282
|
-
|
|
283
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
284
|
-
|
|
285
|
-
ALIASES
|
|
286
|
-
$ codiac asset:new
|
|
287
|
-
```
|
|
288
|
-
|
|
289
|
-
_See code: [src/commands/asset/helm.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/asset/helm.ts)_
|
|
290
|
-
|
|
291
|
-
## `codiac asset:list`
|
|
292
|
-
|
|
293
|
-
Shows the list of assets in a given enterprise.
|
|
294
|
-
|
|
295
|
-
```
|
|
296
|
-
USAGE
|
|
297
|
-
$ codiac asset:list
|
|
298
|
-
|
|
299
|
-
OPTIONS
|
|
300
|
-
-h, --help Displays the help document for this command.
|
|
301
|
-
-o, --output=(json|yaml|tree|text) [default: tree] format in which to render the data.
|
|
302
|
-
|
|
303
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
304
|
-
output.
|
|
305
|
-
|
|
306
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
307
|
-
--rememberAs flag.
|
|
308
|
-
|
|
309
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets
|
|
310
|
-
called.
|
|
311
|
-
|
|
312
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
313
|
-
|
|
314
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
315
|
-
arguments that were previously stored under the given name (use "--unRemember
|
|
316
|
-
default" to clear default argument list memorized with the --remember flag).
|
|
317
|
-
|
|
318
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
319
|
-
```
|
|
320
|
-
|
|
321
|
-
_See code: [src/commands/asset/list.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/asset/list.ts)_
|
|
322
|
-
|
|
323
|
-
## `codiac asset:probe:create [CMD]`
|
|
324
|
-
|
|
325
|
-
Declares the implementation of a health or readiness probe for an asset.
|
|
326
|
-
|
|
327
|
-
```
|
|
328
|
-
USAGE
|
|
329
|
-
$ codiac asset:probe:create [CMD]
|
|
330
|
-
|
|
331
|
-
ARGUMENTS
|
|
332
|
-
CMD (requires --exec) command and its space-separated arguments to run in the target replica.
|
|
333
|
-
|
|
334
|
-
OPTIONS
|
|
335
|
-
-a, --asset=asset The name of the asset to which this probe is to apply.
|
|
336
|
-
|
|
337
|
-
-d, --delay=delay [default: 0] The time (in seconds) to wait before the first execution of the
|
|
338
|
-
probe.
|
|
339
|
-
|
|
340
|
-
-h, --help Show CLI help.
|
|
341
|
-
|
|
342
|
-
-h, --httpHeader=httpHeader (For use only with http) Key value pair (in format x=y) to be used as an
|
|
343
|
-
http header in an http probe action.
|
|
344
|
-
|
|
345
|
-
-n, --enterprise=enterprise The name of the enterprise to which this probe is to apply.
|
|
346
|
-
|
|
347
|
-
-p, --period=period [default: 10] How often (in seconds) to fire the probe.
|
|
348
|
-
|
|
349
|
-
-u, --usage=(readiness|liveness|startup) (required) [default: readiness] The diagnostic purpose the probe will serve.
|
|
350
|
-
|
|
351
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
352
|
-
output.
|
|
353
|
-
|
|
354
|
-
-v, --versions=versions Asset version range for which this probe is to be used. (optional: defaults
|
|
355
|
-
to >=latest)
|
|
356
|
-
|
|
357
|
-
-x, --action=action The JSON specification for the probe action itself. The structure follows
|
|
358
|
-
the actionType.
|
|
359
|
-
|
|
360
|
-
--as=as Fires this command with an argument list that was previously remembered
|
|
361
|
-
using the --rememberAs flag.
|
|
362
|
-
|
|
363
|
-
--exec Declares the probe shall be carried out as an executable CLI command. A
|
|
364
|
-
return code of zero indicates success. Any nonzero result indicates
|
|
365
|
-
failure.
|
|
366
|
-
|
|
367
|
-
--execCommand=execCommand (For use only with exec) The executable command to run as the probe, as a
|
|
368
|
-
single string, or as an array of commands and arguments. If it returns any
|
|
369
|
-
nonzero result, the probe gets interpreted as a negative/failure.
|
|
370
|
-
|
|
371
|
-
--grpc Declares the probe shall be carried out as a grpc api request.
|
|
372
|
-
|
|
373
|
-
--grpcHost=grpcHost (For use only with grpc).
|
|
374
|
-
|
|
375
|
-
--grpcPort=grpcPort (For use only with grpc).
|
|
376
|
-
|
|
377
|
-
--http Declares the probe shall be carried out as an http request. Any code greater
|
|
378
|
-
than or equal to 200 and less than 400 indicates success. Any other code
|
|
379
|
-
indicates failure.
|
|
380
|
-
|
|
381
|
-
--httpHost=httpHost .
|
|
382
|
-
|
|
383
|
-
--httpPath=httpPath (For use only with http).
|
|
384
|
-
|
|
385
|
-
--httpPort=httpPort (For use only with http).
|
|
386
|
-
|
|
387
|
-
--httpScheme=http|https (For use only with http) The http protocol to use.
|
|
388
|
-
|
|
389
|
-
--predefined=predefined Calls out by name for an existing standard or shared probe action. Use this
|
|
390
|
-
argument instead of defining the probe action with the exec, grpc, http or
|
|
391
|
-
socket arguments.
|
|
392
|
-
|
|
393
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command
|
|
394
|
-
gets called.
|
|
395
|
-
|
|
396
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
397
|
-
|
|
398
|
-
--socket Declares the probe shall be carried out as a TCP Socket request.
|
|
399
|
-
|
|
400
|
-
--socketHost=socketHost (For use only with socket).
|
|
401
|
-
|
|
402
|
-
--socketPort=socketPort (For use only with socket).
|
|
403
|
-
|
|
404
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
405
|
-
arguments that were previously stored under the given name (use
|
|
406
|
-
"--unRemember default" to clear default argument list memorized with the
|
|
407
|
-
--remember flag).
|
|
408
|
-
|
|
409
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
410
|
-
|
|
411
|
-
ALIASES
|
|
412
|
-
$ codiac asset:probe:create
|
|
413
|
-
|
|
414
|
-
EXAMPLES
|
|
415
|
-
cod probe:create --predefined builtin-heartbeat-file-exists
|
|
416
|
-
cod probe:create -p 15 --exec --execCommand "cat /app/data/last-heartbeat.json"
|
|
417
|
-
cod probe:create -n acme -a myapi -u readiness -p 15 --exec --execCommand "cat /app/data/last-heartbeat.json"
|
|
418
|
-
cod probe:create -n acme -a myapi -u readiness -p 15 --exec --execCommand cat --execCommand
|
|
419
|
-
/app/data/last-heartbeat.json
|
|
420
|
-
cod probe:create -n acme -a myapi -u readiness -p 15 --http --httpScheme https --httpHost myapi.acme.com --httpPort
|
|
421
|
-
443 --httpPath /diag/heartbeat -h Accept=application/json -h user-agent=MyUserAgent
|
|
422
|
-
```
|
|
423
|
-
|
|
424
|
-
_See code: [src/commands/asset/probe/create.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/asset/probe/create.ts)_
|
|
425
|
-
|
|
426
|
-
## `codiac asset:recycle`
|
|
427
|
-
|
|
428
|
-
Deploys a given asset to a given cabinet. Defaults to current version.
|
|
429
|
-
|
|
430
|
-
```
|
|
431
|
-
USAGE
|
|
432
|
-
$ codiac asset:recycle
|
|
433
|
-
|
|
434
|
-
OPTIONS
|
|
435
|
-
-a, --asset=asset Search string for the name of the asset to deploy (use ? to be prompted).
|
|
436
|
-
-c, --cabinetName=cabinetName Target cabinet name you want deploy
|
|
437
|
-
-e, --enterpriseCode=enterpriseCode Code (name) of the enterprise to deploy
|
|
438
|
-
-h, --help Show CLI help.
|
|
439
|
-
|
|
440
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
441
|
-
output.
|
|
442
|
-
|
|
443
|
-
-v, --version=version Search string for the version of the asset to deploy (use ? to be prompted).
|
|
444
|
-
|
|
445
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are
|
|
446
|
-
remembered from prior runs. Requires: enterpriseCode,cabinetName
|
|
447
|
-
|
|
448
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
449
|
-
--rememberAs flag.
|
|
450
|
-
|
|
451
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets
|
|
452
|
-
called.
|
|
453
|
-
|
|
454
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
455
|
-
|
|
456
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
457
|
-
arguments that were previously stored under the given name (use "--unRemember
|
|
458
|
-
default" to clear default argument list memorized with the --remember flag).
|
|
459
|
-
|
|
460
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
461
|
-
```
|
|
462
|
-
|
|
463
|
-
_See code: [src/commands/asset/recycle.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/asset/recycle.ts)_
|
|
464
|
-
|
|
465
|
-
## `codiac asset:view [CMD]`
|
|
466
|
-
|
|
467
|
-
Renders a selected type of content for an asset
|
|
468
|
-
|
|
469
|
-
```
|
|
470
|
-
USAGE
|
|
471
|
-
$ codiac asset:view [CMD]
|
|
472
|
-
|
|
473
|
-
ARGUMENTS
|
|
474
|
-
CMD (requires type=exec) command and its space-separated arguments to run in the target replica.
|
|
475
|
-
|
|
476
|
-
OPTIONS
|
|
477
|
-
-F, --configFile=configFile (requires type=config) The root pathname to the config file to fetch.
|
|
478
|
-
-a, --asset=asset The name of the asset to view.
|
|
479
|
-
-c, --cabinet=cabinet The name of the cabinet from which the content is to be drawn.
|
|
480
|
-
-e, --enterprise=enterprise The name of the enterprise containing the asset being viewed.
|
|
481
|
-
-f, --logsFollow (requires type=logs) Follow (aka watch, tail, stream) the output.
|
|
482
|
-
-h, --help Show CLI help.
|
|
483
|
-
|
|
484
|
-
-l, --logsTail=logsTail [default: 10] (requires type=logs) Lines of recent logs to include in
|
|
485
|
-
the output. Enter -1 to include the entire log history stored in the
|
|
486
|
-
container.
|
|
487
|
-
|
|
488
|
-
-n, --environment=environment The name of the environment in which the cabinet resides.
|
|
489
|
-
|
|
490
|
-
-r, --replica=replica The name of one of the asset instances currently running in the
|
|
491
|
-
cabinet.
|
|
492
|
-
|
|
493
|
-
-t, --type=(logs|term|exec|env|config|status) The type of content to retrieve.
|
|
494
|
-
|
|
495
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the
|
|
496
|
-
console output.
|
|
497
|
-
|
|
498
|
-
--as=as Fires this command with an argument list that was previously remembered
|
|
499
|
-
using the --rememberAs flag.
|
|
500
|
-
|
|
501
|
-
--echo Echo interaction mode; renders the equivalent non-interactive cli
|
|
502
|
-
command for future use before final execution.
|
|
503
|
-
|
|
504
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this
|
|
505
|
-
command gets called.
|
|
506
|
-
|
|
507
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
508
|
-
|
|
509
|
-
--silent Non-Interactive mode; executes without any user interaction and fails
|
|
510
|
-
on any missing or invalid arguments.
|
|
511
|
-
|
|
512
|
-
--takeDefaults Prevents prompting for confirmation on parameters that were passed in
|
|
513
|
-
or were set to default values.
|
|
514
|
-
|
|
515
|
-
--terminal=(bash|sh) Command used to start the terminal (defaults to "bash")
|
|
516
|
-
|
|
517
|
-
--toscript Toscript interaction mode; renders the equivalent non-interactive cli
|
|
518
|
-
command WITHOUT any execution.
|
|
519
|
-
|
|
520
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears
|
|
521
|
-
the arguments that were previously stored under the given name (use
|
|
522
|
-
"--unRemember default" to clear default argument list memorized with
|
|
523
|
-
the --remember flag).
|
|
524
|
-
|
|
525
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
526
|
-
|
|
527
|
-
ALIASES
|
|
528
|
-
$ codiac asset:monitor
|
|
529
|
-
$ codiac asset:mon
|
|
530
|
-
$ codiac asset:get
|
|
531
|
-
```
|
|
532
|
-
|
|
533
|
-
_See code: [src/commands/asset/view.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/asset/view.ts)_
|
|
534
|
-
|
|
535
|
-
## `codiac asset:volume:create [MOUNTPATH]`
|
|
536
|
-
|
|
537
|
-
Declares a named path for mounting a volume to instances of the asset.
|
|
538
|
-
|
|
539
|
-
```
|
|
540
|
-
USAGE
|
|
541
|
-
$ codiac asset:volume:create [MOUNTPATH]
|
|
542
|
-
|
|
543
|
-
ARGUMENTS
|
|
544
|
-
MOUNTPATH Fully qualified mounting path, inside the container, of the folder being mapped as a volume. Must be
|
|
545
|
-
unique for the asset.
|
|
546
|
-
|
|
547
|
-
OPTIONS
|
|
548
|
-
-d, --description=description Any notes or other information to help clarify the intended purpose of this folder, to
|
|
549
|
-
assist during the configuration phase when assigning an actual physical file store to
|
|
550
|
-
it.
|
|
551
|
-
|
|
552
|
-
-h, --help Show CLI help.
|
|
553
|
-
|
|
554
|
-
-n, --name=name Moniker for identifying, retrieving, and accessing this folder mapping. Must be unique
|
|
555
|
-
for the asset.
|
|
556
|
-
|
|
557
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
558
|
-
|
|
559
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered
|
|
560
|
-
from prior runs. Requires: name
|
|
561
|
-
|
|
562
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
563
|
-
--rememberAs flag.
|
|
564
|
-
|
|
565
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
566
|
-
|
|
567
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
568
|
-
|
|
569
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments
|
|
570
|
-
that were previously stored under the given name (use "--unRemember default" to clear
|
|
571
|
-
default argument list memorized with the --remember flag).
|
|
572
|
-
|
|
573
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
574
|
-
|
|
575
|
-
ALIASES
|
|
576
|
-
$ codiac asset:vol:create
|
|
577
|
-
$ codiac asset:vol:add
|
|
578
|
-
$ codiac asset:volume:add
|
|
579
|
-
```
|
|
580
|
-
|
|
581
|
-
_See code: [src/commands/asset/volume/create.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/asset/volume/create.ts)_
|
|
582
|
-
|
|
583
|
-
## `codiac asset:volume:delete`
|
|
584
|
-
|
|
585
|
-
Deletes an existing volume mount in the asset
|
|
586
|
-
|
|
587
|
-
```
|
|
588
|
-
USAGE
|
|
589
|
-
$ codiac asset:volume:delete
|
|
590
|
-
|
|
591
|
-
OPTIONS
|
|
592
|
-
-h, --help Show CLI help.
|
|
593
|
-
|
|
594
|
-
-n, --name=name Moniker for identifying, retrieving, and accessing this folder mapping. Must be unique for
|
|
595
|
-
the asset.
|
|
596
|
-
|
|
597
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
598
|
-
|
|
599
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
|
|
600
|
-
prior runs. Requires: name
|
|
601
|
-
|
|
602
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
603
|
-
--rememberAs flag.
|
|
604
|
-
|
|
605
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
606
|
-
|
|
607
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
608
|
-
|
|
609
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
610
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
611
|
-
list memorized with the --remember flag).
|
|
612
|
-
|
|
613
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
614
|
-
|
|
615
|
-
ALIASES
|
|
616
|
-
$ codiac asset:vol:delete
|
|
617
|
-
$ codiac asset:volumes:delete
|
|
618
|
-
$ codiac asset:volume:del
|
|
619
|
-
$ codiac asset:vol:del
|
|
620
|
-
$ codiac asset:volumes:del
|
|
621
|
-
```
|
|
622
|
-
|
|
623
|
-
_See code: [src/commands/asset/volume/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/asset/volume/delete.ts)_
|
|
624
|
-
|
|
625
|
-
## `codiac asset:volume:list`
|
|
626
|
-
|
|
627
|
-
Renders the currently declared mount paths for the asset.
|
|
628
|
-
|
|
629
|
-
```
|
|
630
|
-
USAGE
|
|
631
|
-
$ codiac asset:volume:list
|
|
632
|
-
|
|
633
|
-
OPTIONS
|
|
634
|
-
-h, --help Show CLI help.
|
|
635
|
-
-n, --name=name Filter volumes within the asset by mount name.
|
|
636
|
-
-o, --output=(pretty|json|yaml|auto) [default: auto] Output format of the actual settings data document.
|
|
637
|
-
-p, --path=path Filter volumes within the asset by mount path.
|
|
638
|
-
|
|
639
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
640
|
-
output.
|
|
641
|
-
|
|
642
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are
|
|
643
|
-
remembered from prior runs. Requires: name
|
|
644
|
-
|
|
645
|
-
--as=as Fires this command with an argument list that was previously remembered using
|
|
646
|
-
the --rememberAs flag.
|
|
647
|
-
|
|
648
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets
|
|
649
|
-
called.
|
|
650
|
-
|
|
651
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
652
|
-
|
|
653
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
654
|
-
arguments that were previously stored under the given name (use "--unRemember
|
|
655
|
-
default" to clear default argument list memorized with the --remember flag).
|
|
656
|
-
|
|
657
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
658
|
-
|
|
659
|
-
ALIASES
|
|
660
|
-
$ codiac asset:vol:list
|
|
661
|
-
$ codiac asset:volumes:list
|
|
662
|
-
```
|
|
663
|
-
|
|
664
|
-
_See code: [src/commands/asset/volume/list.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/asset/volume/list.ts)_
|
|
665
|
-
|
|
666
|
-
## `codiac autocomplete [SHELL]`
|
|
667
|
-
|
|
668
|
-
display autocomplete installation instructions
|
|
669
|
-
|
|
670
|
-
```
|
|
671
|
-
USAGE
|
|
672
|
-
$ codiac autocomplete [SHELL]
|
|
673
|
-
|
|
674
|
-
ARGUMENTS
|
|
675
|
-
SHELL shell type
|
|
676
|
-
|
|
677
|
-
OPTIONS
|
|
678
|
-
-r, --refresh-cache Refresh cache (ignores displaying instructions)
|
|
679
|
-
|
|
680
|
-
EXAMPLES
|
|
681
|
-
$ codiac autocomplete
|
|
682
|
-
$ codiac autocomplete bash
|
|
683
|
-
$ codiac autocomplete zsh
|
|
684
|
-
$ codiac autocomplete --refresh-cache
|
|
685
|
-
```
|
|
686
|
-
|
|
687
|
-
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.3.6/src/commands/autocomplete/index.ts)_
|
|
688
|
-
|
|
689
|
-
## `codiac branch [NAME]`
|
|
690
|
-
|
|
691
|
-
Creates a new branch for the parent project and any sourced dependencies.
|
|
692
|
-
|
|
693
|
-
```
|
|
694
|
-
USAGE
|
|
695
|
-
$ codiac branch [NAME]
|
|
696
|
-
|
|
697
|
-
ARGUMENTS
|
|
698
|
-
NAME The name of the branch to create.
|
|
699
|
-
|
|
700
|
-
OPTIONS
|
|
701
|
-
-h, --help Show CLI help.
|
|
702
|
-
-s, --switch Automatically switches to the new branch after creating it.
|
|
703
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
704
|
-
|
|
705
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
706
|
-
--rememberAs flag.
|
|
707
|
-
|
|
708
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
709
|
-
|
|
710
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
711
|
-
|
|
712
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
713
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
714
|
-
list memorized with the --remember flag).
|
|
715
|
-
|
|
716
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
717
|
-
```
|
|
718
|
-
|
|
719
|
-
_See code: [src/commands/branch.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/branch.ts)_
|
|
720
|
-
|
|
721
|
-
## `codiac branch:current`
|
|
722
|
-
|
|
723
|
-
Renders the name of the current branch (for the main project and for any sourced dependencies).
|
|
724
|
-
|
|
725
|
-
```
|
|
726
|
-
USAGE
|
|
727
|
-
$ codiac branch:current
|
|
728
|
-
|
|
729
|
-
OPTIONS
|
|
730
|
-
-h, --help Show CLI help.
|
|
731
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
732
|
-
|
|
733
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
734
|
-
--rememberAs flag.
|
|
735
|
-
|
|
736
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
737
|
-
|
|
738
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
739
|
-
|
|
740
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
741
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
742
|
-
list memorized with the --remember flag).
|
|
743
|
-
|
|
744
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
745
|
-
|
|
746
|
-
ALIASES
|
|
747
|
-
$ codiac branches:current
|
|
748
|
-
```
|
|
749
|
-
|
|
750
|
-
_See code: [src/commands/branch/current.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/branch/current.ts)_
|
|
751
|
-
|
|
752
|
-
## `codiac branch:list`
|
|
753
|
-
|
|
754
|
-
Lists out existing branches for the project repo.
|
|
755
|
-
|
|
756
|
-
```
|
|
757
|
-
USAGE
|
|
758
|
-
$ codiac branch:list
|
|
759
|
-
|
|
760
|
-
OPTIONS
|
|
761
|
-
-h, --help Displays the help document for this command.
|
|
762
|
-
-l, --locals (Optional, defaults to false) Limits to local branches only.
|
|
763
|
-
-r, --remotes (Optional, defaults to false) Limits to remote branches only.
|
|
764
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
765
|
-
|
|
766
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
767
|
-
--rememberAs flag.
|
|
768
|
-
|
|
769
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
770
|
-
|
|
771
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
772
|
-
|
|
773
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
774
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
775
|
-
list memorized with the --remember flag).
|
|
776
|
-
|
|
777
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
778
|
-
|
|
779
|
-
ALIASES
|
|
780
|
-
$ codiac branches:list
|
|
781
|
-
```
|
|
782
|
-
|
|
783
|
-
_See code: [src/commands/branch/list.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/branch/list.ts)_
|
|
784
|
-
|
|
785
|
-
## `codiac build`
|
|
786
|
-
|
|
787
|
-
Builds the project and the docker container
|
|
788
|
-
|
|
789
|
-
```
|
|
790
|
-
USAGE
|
|
791
|
-
$ codiac build
|
|
792
|
-
|
|
793
|
-
OPTIONS
|
|
794
|
-
-M, --major Increments the version by one Major version number (using Major.Minor.Patch).
|
|
795
|
-
|
|
796
|
-
-b, --buildDef=buildDef Replaces the default build command with the given process. For a
|
|
797
|
-
multi-command sequence, separate each with a Pipe (|) character.
|
|
798
|
-
|
|
799
|
-
-c, --clear Completely deletes the output folder before building.
|
|
800
|
-
|
|
801
|
-
-d, --asDefault Overwrites the default build command for the project with the buildDef
|
|
802
|
-
argument
|
|
803
|
-
|
|
804
|
-
-f, --frameworkVersion=frameworkVersion (Future) Explicitly sets the version of the Toyhauler base image to use
|
|
805
|
-
(default: latest).
|
|
806
|
-
|
|
807
|
-
-h, --help Show CLI help.
|
|
808
|
-
|
|
809
|
-
-i, --image=image (optional, defaults to all) Limits the list of images to build. Value must
|
|
810
|
-
match the name property of an image export defined in the codiac project file
|
|
811
|
-
(codiac.json)
|
|
812
|
-
|
|
813
|
-
-m, --minor Increments the version by one Minor version number (using Major.Minor.Patch).
|
|
814
|
-
|
|
815
|
-
-n, --noCache Ignores the local Docker image cache, thereby forcing a fresh download of
|
|
816
|
-
each image from its container registry layer in the build.
|
|
817
|
-
|
|
818
|
-
-p, --patch Increments the version by one Patch version number (using Major.Minor.Patch).
|
|
819
|
-
|
|
820
|
-
-r, --prerelease Increments the prerelease number (using Major.Minor.Patch-PreRelease). NOTE:
|
|
821
|
-
Increments the Patch version number when appending.
|
|
822
|
-
|
|
823
|
-
-s, --skip=(images|packages) (optional) Prevents the building of any declared container images or
|
|
824
|
-
packages.
|
|
825
|
-
|
|
826
|
-
-t, --buildTarget=buildTarget (optional) Calls out the only stage to be built for images defined with
|
|
827
|
-
multistage builds.
|
|
828
|
-
|
|
829
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
830
|
-
output.
|
|
831
|
-
|
|
832
|
-
--as=as Fires this command with an argument list that was previously remembered using
|
|
833
|
-
the --rememberAs flag.
|
|
834
|
-
|
|
835
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command
|
|
836
|
-
gets called.
|
|
837
|
-
|
|
838
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
839
|
-
|
|
840
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
841
|
-
arguments that were previously stored under the given name (use "--unRemember
|
|
842
|
-
default" to clear default argument list memorized with the --remember flag).
|
|
843
|
-
|
|
844
|
-
--version=version Overwrites the full version for the build (using Major.Minor.Patch).
|
|
845
|
-
|
|
846
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
847
|
-
```
|
|
848
|
-
|
|
849
|
-
_See code: [src/commands/build.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/build.ts)_
|
|
850
|
-
|
|
851
|
-
## `codiac cabinet:create [CABINET]`
|
|
852
|
-
|
|
853
|
-
Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.
|
|
854
|
-
|
|
855
|
-
```
|
|
856
|
-
USAGE
|
|
857
|
-
$ codiac cabinet:create [CABINET]
|
|
858
|
-
|
|
859
|
-
ARGUMENTS
|
|
860
|
-
CABINET The name of the cabinet to create
|
|
861
|
-
|
|
862
|
-
OPTIONS
|
|
863
|
-
-e, --environment=environment (optional: defaults to that of the current project branch) The name of the environment
|
|
864
|
-
this cabinet will be grouped under.
|
|
865
|
-
|
|
866
|
-
-f, --force Overwrites and reinitializes if the cabinet already exists.
|
|
867
|
-
|
|
868
|
-
-h, --help Show CLI help.
|
|
869
|
-
|
|
870
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
871
|
-
|
|
872
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
873
|
-
--rememberAs flag.
|
|
874
|
-
|
|
875
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
876
|
-
|
|
877
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
878
|
-
|
|
879
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments
|
|
880
|
-
that were previously stored under the given name (use "--unRemember default" to clear
|
|
881
|
-
default argument list memorized with the --remember flag).
|
|
882
|
-
|
|
883
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
884
|
-
|
|
885
|
-
ALIASES
|
|
886
|
-
$ codiac cab:create
|
|
887
|
-
```
|
|
888
|
-
|
|
889
|
-
_See code: [src/commands/cabinet/create.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/cabinet/create.ts)_
|
|
890
|
-
|
|
891
|
-
## `codiac cabinet:list`
|
|
892
|
-
|
|
893
|
-
Shows the list of cabinets and environment.
|
|
894
|
-
|
|
895
|
-
```
|
|
896
|
-
USAGE
|
|
897
|
-
$ codiac cabinet:list
|
|
898
|
-
|
|
899
|
-
OPTIONS
|
|
900
|
-
-h, --help Displays the help document for this command.
|
|
901
|
-
-o, --output=(json|yaml|tree|text) [default: tree] format in which to render the data.
|
|
902
|
-
|
|
903
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
904
|
-
output.
|
|
905
|
-
|
|
906
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
907
|
-
--rememberAs flag.
|
|
908
|
-
|
|
909
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets
|
|
910
|
-
called.
|
|
911
|
-
|
|
912
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
913
|
-
|
|
914
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
915
|
-
arguments that were previously stored under the given name (use "--unRemember
|
|
916
|
-
default" to clear default argument list memorized with the --remember flag).
|
|
917
|
-
|
|
918
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
919
|
-
|
|
920
|
-
ALIASES
|
|
921
|
-
$ codiac cab:list
|
|
922
|
-
```
|
|
923
|
-
|
|
924
|
-
_See code: [src/commands/cabinet/list.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/cabinet/list.ts)_
|
|
925
|
-
|
|
926
|
-
## `codiac cabinet:obliterate [CABINET]`
|
|
927
|
-
|
|
928
|
-
Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.
|
|
929
|
-
|
|
930
|
-
```
|
|
931
|
-
USAGE
|
|
932
|
-
$ codiac cabinet:obliterate [CABINET]
|
|
933
|
-
|
|
934
|
-
ARGUMENTS
|
|
935
|
-
CABINET The name of the cabinet
|
|
936
|
-
|
|
937
|
-
OPTIONS
|
|
938
|
-
-e, --environment=environment (optional: defaults to that of the current project branch) The name of the environment
|
|
939
|
-
this cabinet will be grouped under.
|
|
940
|
-
|
|
941
|
-
-h, --help Show CLI help.
|
|
942
|
-
|
|
943
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
944
|
-
|
|
945
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
946
|
-
--rememberAs flag.
|
|
947
|
-
|
|
948
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
949
|
-
|
|
950
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
951
|
-
|
|
952
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments
|
|
953
|
-
that were previously stored under the given name (use "--unRemember default" to clear
|
|
954
|
-
default argument list memorized with the --remember flag).
|
|
955
|
-
|
|
956
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
957
|
-
|
|
958
|
-
ALIASES
|
|
959
|
-
$ codiac cab:obliterate
|
|
960
|
-
```
|
|
961
|
-
|
|
962
|
-
_See code: [src/commands/cabinet/obliterate.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/cabinet/obliterate.ts)_
|
|
963
|
-
|
|
964
|
-
## `codiac cli`
|
|
965
|
-
|
|
966
|
-
Applies settings to the Codiac CLI itself (scoped to the local machine).
|
|
967
|
-
|
|
968
|
-
```
|
|
969
|
-
USAGE
|
|
970
|
-
$ codiac cli
|
|
971
|
-
|
|
972
|
-
OPTIONS
|
|
973
|
-
-h, --help Show the help docs for this command.
|
|
974
|
-
|
|
975
|
-
-s, --set=set A key=value expression for the setting to apply. Leave this argument out of your call to get
|
|
976
|
-
a list of the available settings keys and their types.
|
|
977
|
-
|
|
978
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
979
|
-
|
|
980
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
981
|
-
--rememberAs flag.
|
|
982
|
-
|
|
983
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
984
|
-
|
|
985
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
986
|
-
|
|
987
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
988
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
989
|
-
list memorized with the --remember flag).
|
|
990
|
-
|
|
991
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
992
|
-
```
|
|
993
|
-
|
|
994
|
-
_See code: [src/commands/cli.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/cli.ts)_
|
|
995
|
-
|
|
996
|
-
## `codiac commit [MESSAGE]`
|
|
997
|
-
|
|
998
|
-
Commits the currently staged changes on the current branch of the main project and on any sourced dependencies.
|
|
999
|
-
|
|
1000
|
-
```
|
|
1001
|
-
USAGE
|
|
1002
|
-
$ codiac commit [MESSAGE]
|
|
1003
|
-
|
|
1004
|
-
ARGUMENTS
|
|
1005
|
-
MESSAGE The description to include in this particular commit.
|
|
1006
|
-
|
|
1007
|
-
OPTIONS
|
|
1008
|
-
-h, --help Show CLI help.
|
|
1009
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1010
|
-
|
|
1011
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1012
|
-
--rememberAs flag.
|
|
1013
|
-
|
|
1014
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1015
|
-
|
|
1016
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1017
|
-
|
|
1018
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
1019
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
1020
|
-
list memorized with the --remember flag).
|
|
1021
|
-
|
|
1022
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1023
|
-
```
|
|
1024
|
-
|
|
1025
|
-
_See code: [src/commands/commit.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/commit.ts)_
|
|
1026
|
-
|
|
1027
|
-
## `codiac config:add [SETTING]`
|
|
1028
|
-
|
|
1029
|
-
Adds a key value pair to the app config
|
|
1030
|
-
|
|
1031
|
-
```
|
|
1032
|
-
USAGE
|
|
1033
|
-
$ codiac config:add [SETTING]
|
|
1034
|
-
|
|
1035
|
-
ARGUMENTS
|
|
1036
|
-
SETTING The key for the config setting to add
|
|
1037
|
-
|
|
1038
|
-
OPTIONS
|
|
1039
|
-
-c, --cabinet=cabinet The name of the cabinet to which this value is to apply.
|
|
1040
|
-
-e, --environment=environment The name of the environment to which this value is to apply.
|
|
1041
|
-
|
|
1042
|
-
-f, --file=file The path-name to the file to which the settings are written, relative to the root of
|
|
1043
|
-
the Codiac project.
|
|
1044
|
-
|
|
1045
|
-
-h, --help Show CLI help.
|
|
1046
|
-
|
|
1047
|
-
-n, --enterprise=enterprise The name of the enterprise to which this value is to apply.
|
|
1048
|
-
|
|
1049
|
-
-s, --setting=setting The config key (in dotpath/JSONPath), relative to the root of the config.
|
|
1050
|
-
|
|
1051
|
-
-v, --value=value The actual concrete data to be applied as the setting value.
|
|
1052
|
-
|
|
1053
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1054
|
-
|
|
1055
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1056
|
-
--rememberAs flag.
|
|
1057
|
-
|
|
1058
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1059
|
-
|
|
1060
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1061
|
-
|
|
1062
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments
|
|
1063
|
-
that were previously stored under the given name (use "--unRemember default" to clear
|
|
1064
|
-
default argument list memorized with the --remember flag).
|
|
1065
|
-
|
|
1066
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1067
|
-
|
|
1068
|
-
ALIASES
|
|
1069
|
-
$ codiac config:set
|
|
1070
|
-
$ codiac cfg:add
|
|
1071
|
-
```
|
|
1072
|
-
|
|
1073
|
-
_See code: [src/commands/config/add.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/config/add.ts)_
|
|
1074
|
-
|
|
1075
|
-
## `codiac config:delete [SETTING]`
|
|
1076
|
-
|
|
1077
|
-
Removes the given keys from the app config
|
|
1078
|
-
|
|
1079
|
-
```
|
|
1080
|
-
USAGE
|
|
1081
|
-
$ codiac config:delete [SETTING]
|
|
1082
|
-
|
|
1083
|
-
ARGUMENTS
|
|
1084
|
-
SETTING (optional) Specific config key to remove. Omit to select from a list. Enter "all" to clear the entire config.
|
|
1085
|
-
|
|
1086
|
-
OPTIONS
|
|
1087
|
-
-c, --cabinet=cabinet The name of the cabinet to which this value is to apply.
|
|
1088
|
-
-e, --environment=environment The name of the environment to which this value is to apply.
|
|
1089
|
-
|
|
1090
|
-
-f, --file=file The path-name to the config file holding the settings, relative to the root of the
|
|
1091
|
-
Codiac project.
|
|
1092
|
-
|
|
1093
|
-
-h, --help Show CLI help.
|
|
1094
|
-
|
|
1095
|
-
-n, --enterprise=enterprise The name of the enterprise to which this value is to apply.
|
|
1096
|
-
|
|
1097
|
-
-s, --setting=setting The config key (in dotpath/JSONPath), relative to the root of the config.
|
|
1098
|
-
|
|
1099
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1100
|
-
|
|
1101
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1102
|
-
--rememberAs flag.
|
|
1103
|
-
|
|
1104
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1105
|
-
|
|
1106
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1107
|
-
|
|
1108
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments
|
|
1109
|
-
that were previously stored under the given name (use "--unRemember default" to clear
|
|
1110
|
-
default argument list memorized with the --remember flag).
|
|
1111
|
-
|
|
1112
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1113
|
-
|
|
1114
|
-
ALIASES
|
|
1115
|
-
$ codiac cfg:delete
|
|
1116
|
-
```
|
|
1117
|
-
|
|
1118
|
-
_See code: [src/commands/config/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/config/delete.ts)_
|
|
1119
|
-
|
|
1120
|
-
## `codiac config:deploy`
|
|
1121
|
-
|
|
1122
|
-
Deploys a given asset to a given cabinet. Defaults to current version.
|
|
1123
|
-
|
|
1124
|
-
```
|
|
1125
|
-
USAGE
|
|
1126
|
-
$ codiac config:deploy
|
|
1127
|
-
|
|
1128
|
-
OPTIONS
|
|
1129
|
-
-a, --asset=asset Search string for the name of the asset to deploy (use ? to be prompted).
|
|
1130
|
-
-c, --cabinetName=cabinetName Target cabinet name you want deploy
|
|
1131
|
-
-e, --enterpriseCode=enterpriseCode Code (name) of the enterprise to deploy
|
|
1132
|
-
-h, --help Show CLI help.
|
|
1133
|
-
|
|
1134
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
1135
|
-
output.
|
|
1136
|
-
|
|
1137
|
-
-v, --version=version Search string for the version of the asset to deploy (use ? to be prompted).
|
|
1138
|
-
|
|
1139
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are
|
|
1140
|
-
remembered from prior runs. Requires: enterpriseCode,cabinetName
|
|
1141
|
-
|
|
1142
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1143
|
-
--rememberAs flag.
|
|
1144
|
-
|
|
1145
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets
|
|
1146
|
-
called.
|
|
1147
|
-
|
|
1148
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1149
|
-
|
|
1150
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
1151
|
-
arguments that were previously stored under the given name (use "--unRemember
|
|
1152
|
-
default" to clear default argument list memorized with the --remember flag).
|
|
1153
|
-
|
|
1154
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1155
|
-
```
|
|
1156
|
-
|
|
1157
|
-
_See code: [src/commands/config/deploy.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/config/deploy.ts)_
|
|
1158
|
-
|
|
1159
|
-
## `codiac config:import [SETTING]`
|
|
1160
|
-
|
|
1161
|
-
Adds a key value pair to the app config
|
|
1162
|
-
|
|
1163
|
-
```
|
|
1164
|
-
USAGE
|
|
1165
|
-
$ codiac config:import [SETTING]
|
|
1166
|
-
|
|
1167
|
-
ARGUMENTS
|
|
1168
|
-
SETTING The key for the config setting to add
|
|
1169
|
-
|
|
1170
|
-
OPTIONS
|
|
1171
|
-
-c, --cabinet=cabinet The name of the cabinet to which this value is to apply.
|
|
1172
|
-
-e, --environment=environment The name of the environment to which this value is to apply.
|
|
1173
|
-
|
|
1174
|
-
-f, --runtimePathName=runtimePathName (optional, uses the original filename) The pathname relative to the app root to
|
|
1175
|
-
assume in the container.
|
|
1176
|
-
|
|
1177
|
-
-h, --help Show CLI help.
|
|
1178
|
-
|
|
1179
|
-
-n, --enterprise=enterprise The name of the enterprise to which this value is to apply.
|
|
1180
|
-
|
|
1181
|
-
-s, --sourceFile=sourceFile The path-name to the LOCAL file to which the settings are written, relative to
|
|
1182
|
-
the root of the Codiac project.
|
|
1183
|
-
|
|
1184
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
1185
|
-
output.
|
|
1186
|
-
|
|
1187
|
-
--as=as Fires this command with an argument list that was previously remembered using
|
|
1188
|
-
the --rememberAs flag.
|
|
1189
|
-
|
|
1190
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets
|
|
1191
|
-
called.
|
|
1192
|
-
|
|
1193
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1194
|
-
|
|
1195
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
1196
|
-
arguments that were previously stored under the given name (use "--unRemember
|
|
1197
|
-
default" to clear default argument list memorized with the --remember flag).
|
|
1198
|
-
|
|
1199
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1200
|
-
|
|
1201
|
-
ALIASES
|
|
1202
|
-
$ codiac cfg:add
|
|
1203
|
-
```
|
|
1204
|
-
|
|
1205
|
-
_See code: [src/commands/config/import.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/config/import.ts)_
|
|
1206
|
-
|
|
1207
|
-
## `codiac config:view [SETTING]`
|
|
1208
|
-
|
|
1209
|
-
Shows the values that are explicitly set in the given config
|
|
1210
|
-
|
|
1211
|
-
```
|
|
1212
|
-
USAGE
|
|
1213
|
-
$ codiac config:view [SETTING]
|
|
1214
|
-
|
|
1215
|
-
ARGUMENTS
|
|
1216
|
-
SETTING (optional) Name of specific setting value to view; omit to show all.
|
|
1217
|
-
|
|
1218
|
-
OPTIONS
|
|
1219
|
-
-a, --asset=asset Search string for the name of the asset to deploy (use ? to be prompted).
|
|
1220
|
-
-c, --cabinet=cabinet The name of the cabinet to assemble the configuration for.
|
|
1221
|
-
|
|
1222
|
-
-f, --file=file [default: app-config.json] The relative pathname of the config file to view
|
|
1223
|
-
(relative to the root of the codiac project).
|
|
1224
|
-
|
|
1225
|
-
-h, --help Show CLI help.
|
|
1226
|
-
|
|
1227
|
-
-o, --output=(pretty|json|yaml|auto) [default: auto] Output format of the actual settings data document.
|
|
1228
|
-
|
|
1229
|
-
-p, --prompt Invokes a prompt to select from the existing settings.
|
|
1230
|
-
|
|
1231
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
1232
|
-
output.
|
|
1233
|
-
|
|
1234
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are
|
|
1235
|
-
remembered from prior runs.
|
|
1236
|
-
|
|
1237
|
-
--as=as Fires this command with an argument list that was previously remembered using
|
|
1238
|
-
the --rememberAs flag.
|
|
1239
|
-
|
|
1240
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets
|
|
1241
|
-
called.
|
|
1242
|
-
|
|
1243
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1244
|
-
|
|
1245
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
1246
|
-
arguments that were previously stored under the given name (use "--unRemember
|
|
1247
|
-
default" to clear default argument list memorized with the --remember flag).
|
|
1248
|
-
|
|
1249
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1250
|
-
|
|
1251
|
-
ALIASES
|
|
1252
|
-
$ codiac cfg:view
|
|
1253
|
-
|
|
1254
|
-
EXAMPLES
|
|
1255
|
-
$ cod config:view
|
|
1256
|
-
$ cod config:view port
|
|
1257
|
-
$ cod config:view -p
|
|
1258
|
-
$ cod config:view -o pretty
|
|
1259
|
-
$ cod config:view -c dev2 -f settings.json -o pretty
|
|
1260
|
-
```
|
|
1261
|
-
|
|
1262
|
-
_See code: [src/commands/config/view.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/config/view.ts)_
|
|
1263
|
-
|
|
1264
|
-
## `codiac dep [NAME]`
|
|
1265
|
-
|
|
1266
|
-
Installs a package into current project.
|
|
1267
|
-
|
|
1268
|
-
```
|
|
1269
|
-
USAGE
|
|
1270
|
-
$ codiac dep [NAME]
|
|
1271
|
-
|
|
1272
|
-
ARGUMENTS
|
|
1273
|
-
NAME The official unique name of the package to install.
|
|
1274
|
-
|
|
1275
|
-
OPTIONS
|
|
1276
|
-
-h, --help Show CLI help.
|
|
1277
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1278
|
-
-v, --version=version version of the package to install
|
|
1279
|
-
|
|
1280
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1281
|
-
--rememberAs flag.
|
|
1282
|
-
|
|
1283
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1284
|
-
|
|
1285
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1286
|
-
|
|
1287
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
1288
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
1289
|
-
list memorized with the --remember flag).
|
|
1290
|
-
|
|
1291
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1292
|
-
```
|
|
1293
|
-
|
|
1294
|
-
_See code: [src/commands/dep.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/dep.ts)_
|
|
1295
|
-
|
|
1296
|
-
## `codiac dep:create [URL]`
|
|
1297
|
-
|
|
1298
|
-
Sources a new dependency into the project from an existing repo url, initializes it with the package repository, and publishes the initial version if it is not already. If the package repository is already initialized, the latest package version is used.
|
|
1299
|
-
|
|
1300
|
-
```
|
|
1301
|
-
USAGE
|
|
1302
|
-
$ codiac dep:create [URL]
|
|
1303
|
-
|
|
1304
|
-
ARGUMENTS
|
|
1305
|
-
URL The official clone url for the repository.
|
|
1306
|
-
|
|
1307
|
-
OPTIONS
|
|
1308
|
-
-h, --help Show CLI help.
|
|
1309
|
-
-n, --pkgName=pkgName (required) Package name including any scope prefix (eg: @codiac.io/)
|
|
1310
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1311
|
-
-v, --version=version Version to apply to the dependency package if it has not yet been initialized.
|
|
1312
|
-
|
|
1313
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1314
|
-
--rememberAs flag.
|
|
1315
|
-
|
|
1316
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1317
|
-
|
|
1318
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1319
|
-
|
|
1320
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
1321
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
1322
|
-
list memorized with the --remember flag).
|
|
1323
|
-
|
|
1324
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1325
|
-
```
|
|
1326
|
-
|
|
1327
|
-
_See code: [src/commands/dep/create.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/dep/create.ts)_
|
|
1328
|
-
|
|
1329
|
-
## `codiac dep:install`
|
|
1330
|
-
|
|
1331
|
-
installs any missing dependency packages into the local project folder.
|
|
1332
|
-
|
|
1333
|
-
```
|
|
1334
|
-
USAGE
|
|
1335
|
-
$ codiac dep:install
|
|
1336
|
-
|
|
1337
|
-
OPTIONS
|
|
1338
|
-
-h, --help Show CLI help.
|
|
1339
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1340
|
-
|
|
1341
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1342
|
-
--rememberAs flag.
|
|
1343
|
-
|
|
1344
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1345
|
-
|
|
1346
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1347
|
-
|
|
1348
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
1349
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
1350
|
-
list memorized with the --remember flag).
|
|
1351
|
-
|
|
1352
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1353
|
-
```
|
|
1354
|
-
|
|
1355
|
-
_See code: [src/commands/dep/install.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/dep/install.ts)_
|
|
1356
|
-
|
|
1357
|
-
## `codiac dep:list`
|
|
1358
|
-
|
|
1359
|
-
Shows the dependencies for the project.
|
|
1360
|
-
|
|
1361
|
-
```
|
|
1362
|
-
USAGE
|
|
1363
|
-
$ codiac dep:list
|
|
1364
|
-
|
|
1365
|
-
OPTIONS
|
|
1366
|
-
-h, --help Show CLI help.
|
|
1367
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1368
|
-
|
|
1369
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1370
|
-
--rememberAs flag.
|
|
1371
|
-
|
|
1372
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1373
|
-
|
|
1374
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1375
|
-
|
|
1376
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
1377
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
1378
|
-
list memorized with the --remember flag).
|
|
1379
|
-
|
|
1380
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1381
|
-
```
|
|
1382
|
-
|
|
1383
|
-
_See code: [src/commands/dep/list.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/dep/list.ts)_
|
|
1384
|
-
|
|
1385
|
-
## `codiac dep:remove [NAME]`
|
|
1386
|
-
|
|
1387
|
-
Removes a dependency from the project.
|
|
1388
|
-
|
|
1389
|
-
```
|
|
1390
|
-
USAGE
|
|
1391
|
-
$ codiac dep:remove [NAME]
|
|
1392
|
-
|
|
1393
|
-
ARGUMENTS
|
|
1394
|
-
NAME The official unique name of the dependency package.
|
|
1395
|
-
|
|
1396
|
-
OPTIONS
|
|
1397
|
-
-d, --discard If the dependency to remove is sourced into the project, setting this flag discards all
|
|
1398
|
-
uncommitted changes (staged and unstaged) before removing it. Again, uncomitted changes are
|
|
1399
|
-
LOST when this flag is set.
|
|
1400
|
-
|
|
1401
|
-
-h, --help Show CLI help.
|
|
1402
|
-
|
|
1403
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1404
|
-
|
|
1405
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1406
|
-
--rememberAs flag.
|
|
1407
|
-
|
|
1408
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1409
|
-
|
|
1410
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1411
|
-
|
|
1412
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
1413
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
1414
|
-
list memorized with the --remember flag).
|
|
1415
|
-
|
|
1416
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1417
|
-
```
|
|
1418
|
-
|
|
1419
|
-
_See code: [src/commands/dep/remove.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/dep/remove.ts)_
|
|
1420
|
-
|
|
1421
|
-
## `codiac dep:source [NAME]`
|
|
1422
|
-
|
|
1423
|
-
Loads the source code for the given dependency
|
|
1424
|
-
|
|
1425
|
-
```
|
|
1426
|
-
USAGE
|
|
1427
|
-
$ codiac dep:source [NAME]
|
|
1428
|
-
|
|
1429
|
-
ARGUMENTS
|
|
1430
|
-
NAME The official unique name of the dependency package.
|
|
1431
|
-
|
|
1432
|
-
OPTIONS
|
|
1433
|
-
-d, --distSubPath=distSubPath Subfolder path, relative to the root of the submodule, to the folder from which the
|
|
1434
|
-
package is created, aka: the build output folder or 'dist' folder (eg: bin, dist, or
|
|
1435
|
-
lib, ...etc). This folder is used as the target folder for npm link.
|
|
1436
|
-
|
|
1437
|
-
-h, --help Show CLI help.
|
|
1438
|
-
|
|
1439
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1440
|
-
|
|
1441
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1442
|
-
--rememberAs flag.
|
|
1443
|
-
|
|
1444
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1445
|
-
|
|
1446
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1447
|
-
|
|
1448
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments
|
|
1449
|
-
that were previously stored under the given name (use "--unRemember default" to clear
|
|
1450
|
-
default argument list memorized with the --remember flag).
|
|
1451
|
-
|
|
1452
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1453
|
-
|
|
1454
|
-
ALIASES
|
|
1455
|
-
$ codiac dep:src
|
|
1456
|
-
```
|
|
1457
|
-
|
|
1458
|
-
_See code: [src/commands/dep/source.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/dep/source.ts)_
|
|
1459
|
-
|
|
1460
|
-
## `codiac dep:syncup [DEPENDENCY]`
|
|
1461
|
-
|
|
1462
|
-
Publishes the dependency in its current state and upgrades to it in the main project.
|
|
1463
|
-
|
|
1464
|
-
```
|
|
1465
|
-
USAGE
|
|
1466
|
-
$ codiac dep:syncup [DEPENDENCY]
|
|
1467
|
-
|
|
1468
|
-
ARGUMENTS
|
|
1469
|
-
DEPENDENCY The package name of the dependency to sync up into the main project
|
|
1470
|
-
|
|
1471
|
-
OPTIONS
|
|
1472
|
-
-h, --help Show CLI help.
|
|
1473
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1474
|
-
|
|
1475
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1476
|
-
--rememberAs flag.
|
|
1477
|
-
|
|
1478
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1479
|
-
|
|
1480
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1481
|
-
|
|
1482
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
1483
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
1484
|
-
list memorized with the --remember flag).
|
|
1485
|
-
|
|
1486
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1487
|
-
```
|
|
1488
|
-
|
|
1489
|
-
_See code: [src/commands/dep/syncup.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/dep/syncup.ts)_
|
|
1490
|
-
|
|
1491
|
-
## `codiac dep:unsource [NAME]`
|
|
1492
|
-
|
|
1493
|
-
Exits source mode for the given dependency by physically removing its source code folder from the project, and points the project dependency back to the package version it previously depended on.
|
|
1494
|
-
|
|
1495
|
-
```
|
|
1496
|
-
USAGE
|
|
1497
|
-
$ codiac dep:unsource [NAME]
|
|
1498
|
-
|
|
1499
|
-
ARGUMENTS
|
|
1500
|
-
NAME The official unique name of the dependency package.
|
|
1501
|
-
|
|
1502
|
-
OPTIONS
|
|
1503
|
-
-c, --comment The commit message for any outstanding changes.
|
|
1504
|
-
|
|
1505
|
-
-d, --discard Discards all uncommitted changes (staged and unstaged) before unsourcing, and goes back to
|
|
1506
|
-
the previously installed version of the dependency. Again, uncomitted changes are LOST when
|
|
1507
|
-
this flag is set.
|
|
1508
|
-
|
|
1509
|
-
-h, --help Show CLI help.
|
|
1510
|
-
|
|
1511
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1512
|
-
|
|
1513
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1514
|
-
--rememberAs flag.
|
|
1515
|
-
|
|
1516
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1517
|
-
|
|
1518
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1519
|
-
|
|
1520
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
1521
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
1522
|
-
list memorized with the --remember flag).
|
|
1523
|
-
|
|
1524
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1525
|
-
|
|
1526
|
-
ALIASES
|
|
1527
|
-
$ codiac dep:unsrc
|
|
1528
|
-
```
|
|
1529
|
-
|
|
1530
|
-
_See code: [src/commands/dep/unsource.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/dep/unsource.ts)_
|
|
1531
|
-
|
|
1532
|
-
## `codiac dep:upgrade [DEPENDENCY]`
|
|
1533
|
-
|
|
1534
|
-
describe the command here
|
|
1535
|
-
|
|
1536
|
-
```
|
|
1537
|
-
USAGE
|
|
1538
|
-
$ codiac dep:upgrade [DEPENDENCY]
|
|
1539
|
-
|
|
1540
|
-
ARGUMENTS
|
|
1541
|
-
DEPENDENCY The dependency to upgrade
|
|
1542
|
-
|
|
1543
|
-
OPTIONS
|
|
1544
|
-
-h, --help Show CLI help.
|
|
1545
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1546
|
-
-v, --version=version version of the package to install
|
|
1547
|
-
|
|
1548
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1549
|
-
--rememberAs flag.
|
|
1550
|
-
|
|
1551
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1552
|
-
|
|
1553
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1554
|
-
|
|
1555
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
1556
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
1557
|
-
list memorized with the --remember flag).
|
|
1558
|
-
|
|
1559
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1560
|
-
```
|
|
1561
|
-
|
|
1562
|
-
_See code: [src/commands/dep/upgrade.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/dep/upgrade.ts)_
|
|
1563
|
-
|
|
1564
|
-
## `codiac deploy`
|
|
1565
|
-
|
|
1566
|
-
Deploys a given asset to a given cabinet. Defaults to current version.
|
|
1567
|
-
|
|
1568
|
-
```
|
|
1569
|
-
USAGE
|
|
1570
|
-
$ codiac deploy
|
|
1571
|
-
|
|
1572
|
-
OPTIONS
|
|
1573
|
-
-a, --asset=asset Search string for the name of the asset to deploy (use ? to be prompted).
|
|
1574
|
-
-c, --cabinetName=cabinetName Target cabinet name you want deploy
|
|
1575
|
-
-e, --enterpriseCode=enterpriseCode Code (name) of the enterprise to deploy
|
|
1576
|
-
-h, --help Show CLI help.
|
|
1577
|
-
-n, --providerUserName=providerUserName OPTIONAL: For silent/scripted calls, bring cloud creds to auth against
|
|
1578
|
-
-p, --providerPassword=providerPassword OPTIONAL: For silent/scripted calls, bring cloud creds to auth against
|
|
1579
|
-
-u, --version=version Search string for the version of the asset to deploy (use ? to be prompted).
|
|
1580
|
-
|
|
1581
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
1582
|
-
output.
|
|
1583
|
-
|
|
1584
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are
|
|
1585
|
-
remembered from prior runs. Requires: enterpriseCode,cabinetName
|
|
1586
|
-
|
|
1587
|
-
--as=as Fires this command with an argument list that was previously remembered using
|
|
1588
|
-
the --rememberAs flag.
|
|
1589
|
-
|
|
1590
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command
|
|
1591
|
-
gets called.
|
|
1592
|
-
|
|
1593
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1594
|
-
|
|
1595
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
1596
|
-
arguments that were previously stored under the given name (use "--unRemember
|
|
1597
|
-
default" to clear default argument list memorized with the --remember flag).
|
|
1598
|
-
|
|
1599
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1600
|
-
```
|
|
1601
|
-
|
|
1602
|
-
_See code: [src/commands/deploy.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/deploy.ts)_
|
|
1603
|
-
|
|
1604
|
-
## `codiac enterprise:create [CODE]`
|
|
1605
|
-
|
|
1606
|
-
Creates a new enterprise under the current tenant.
|
|
1607
|
-
|
|
1608
|
-
```
|
|
1609
|
-
USAGE
|
|
1610
|
-
$ codiac enterprise:create [CODE]
|
|
1611
|
-
|
|
1612
|
-
ARGUMENTS
|
|
1613
|
-
CODE The unique human-readable identitifer to use for the enterprise (must be alphanunmeric with no spaces).
|
|
1614
|
-
|
|
1615
|
-
OPTIONS
|
|
1616
|
-
-h, --help Show CLI help.
|
|
1617
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1618
|
-
|
|
1619
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1620
|
-
--rememberAs flag.
|
|
1621
|
-
|
|
1622
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1623
|
-
|
|
1624
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1625
|
-
|
|
1626
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
1627
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
1628
|
-
list memorized with the --remember flag).
|
|
1629
|
-
|
|
1630
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1631
|
-
```
|
|
1632
|
-
|
|
1633
|
-
_See code: [src/commands/enterprise/create.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/enterprise/create.ts)_
|
|
1634
|
-
|
|
1635
|
-
## `codiac enterprise:list`
|
|
1636
|
-
|
|
1637
|
-
Shows the list of enterprises.
|
|
1638
|
-
|
|
1639
|
-
```
|
|
1640
|
-
USAGE
|
|
1641
|
-
$ codiac enterprise:list
|
|
1642
|
-
|
|
1643
|
-
OPTIONS
|
|
1644
|
-
-h, --help Displays the help document for this command.
|
|
1645
|
-
-o, --output=(json|yaml|tree|text) [default: tree] format in which to render the data.
|
|
1646
|
-
|
|
1647
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
1648
|
-
output.
|
|
1649
|
-
|
|
1650
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1651
|
-
--rememberAs flag.
|
|
1652
|
-
|
|
1653
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets
|
|
1654
|
-
called.
|
|
1655
|
-
|
|
1656
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1657
|
-
|
|
1658
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
1659
|
-
arguments that were previously stored under the given name (use "--unRemember
|
|
1660
|
-
default" to clear default argument list memorized with the --remember flag).
|
|
1661
|
-
|
|
1662
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1663
|
-
|
|
1664
|
-
ALIASES
|
|
1665
|
-
$ codiac ent:list
|
|
1666
|
-
```
|
|
1667
|
-
|
|
1668
|
-
_See code: [src/commands/enterprise/list.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/enterprise/list.ts)_
|
|
1669
|
-
|
|
1670
|
-
## `codiac env:add [SETTING]`
|
|
1671
|
-
|
|
1672
|
-
Adds a key value pair to the app config
|
|
1673
|
-
|
|
1674
|
-
```
|
|
1675
|
-
USAGE
|
|
1676
|
-
$ codiac env:add [SETTING]
|
|
1677
|
-
|
|
1678
|
-
ARGUMENTS
|
|
1679
|
-
SETTING The name of the environment variable to add
|
|
1680
|
-
|
|
1681
|
-
OPTIONS
|
|
1682
|
-
-c, --cabinet=cabinet The name of the cabinet to which this value is to apply.
|
|
1683
|
-
-e, --environment=environment The name of the environment to which this value is to apply.
|
|
1684
|
-
-h, --help Show CLI help.
|
|
1685
|
-
-n, --enterprise=enterprise The name of the enterprise to which this value is to apply.
|
|
1686
|
-
-s, --setting=setting The name of the environment variable to add.
|
|
1687
|
-
-v, --value=value The actual concrete data to be applied as the setting value.
|
|
1688
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1689
|
-
|
|
1690
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1691
|
-
--rememberAs flag.
|
|
1692
|
-
|
|
1693
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1694
|
-
|
|
1695
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1696
|
-
|
|
1697
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments
|
|
1698
|
-
that were previously stored under the given name (use "--unRemember default" to clear
|
|
1699
|
-
default argument list memorized with the --remember flag).
|
|
1700
|
-
|
|
1701
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1702
|
-
```
|
|
1703
|
-
|
|
1704
|
-
_See code: [src/commands/env/add.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/env/add.ts)_
|
|
1705
|
-
|
|
1706
|
-
## `codiac environment:create [NAME]`
|
|
1707
|
-
|
|
1708
|
-
Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.
|
|
1709
|
-
|
|
1710
|
-
```
|
|
1711
|
-
USAGE
|
|
1712
|
-
$ codiac environment:create [NAME]
|
|
1713
|
-
|
|
1714
|
-
ARGUMENTS
|
|
1715
|
-
NAME The name of the environment to create
|
|
1716
|
-
|
|
1717
|
-
OPTIONS
|
|
1718
|
-
-h, --help Show CLI help.
|
|
1719
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1720
|
-
|
|
1721
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1722
|
-
--rememberAs flag.
|
|
1723
|
-
|
|
1724
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1725
|
-
|
|
1726
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1727
|
-
|
|
1728
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
1729
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
1730
|
-
list memorized with the --remember flag).
|
|
1731
|
-
|
|
1732
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1733
|
-
|
|
1734
|
-
ALIASES
|
|
1735
|
-
$ codiac enviro:create
|
|
1736
|
-
```
|
|
1737
|
-
|
|
1738
|
-
_See code: [src/commands/environment/create.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/environment/create.ts)_
|
|
1739
|
-
|
|
1740
|
-
## `codiac environment:list`
|
|
1741
|
-
|
|
1742
|
-
Shows the list of environments.
|
|
1743
|
-
|
|
1744
|
-
```
|
|
1745
|
-
USAGE
|
|
1746
|
-
$ codiac environment:list
|
|
1747
|
-
|
|
1748
|
-
OPTIONS
|
|
1749
|
-
-h, --help Displays the help document for this command.
|
|
1750
|
-
-o, --output=(json|yaml|tree|text) [default: tree] format in which to render the data.
|
|
1751
|
-
|
|
1752
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
1753
|
-
output.
|
|
1754
|
-
|
|
1755
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1756
|
-
--rememberAs flag.
|
|
1757
|
-
|
|
1758
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets
|
|
1759
|
-
called.
|
|
1760
|
-
|
|
1761
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1762
|
-
|
|
1763
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
1764
|
-
arguments that were previously stored under the given name (use "--unRemember
|
|
1765
|
-
default" to clear default argument list memorized with the --remember flag).
|
|
1766
|
-
|
|
1767
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1768
|
-
|
|
1769
|
-
ALIASES
|
|
1770
|
-
$ codiac enviro:list
|
|
1771
|
-
```
|
|
1772
|
-
|
|
1773
|
-
_See code: [src/commands/environment/list.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/environment/list.ts)_
|
|
1774
|
-
|
|
1775
|
-
## `codiac filestore:capture`
|
|
1776
|
-
|
|
1777
|
-
Creates a reference point in the given enterprise for an existing filestore instance in a cloud provider subscription.
|
|
1778
|
-
|
|
1779
|
-
```
|
|
1780
|
-
USAGE
|
|
1781
|
-
$ codiac filestore:capture
|
|
1782
|
-
|
|
1783
|
-
OPTIONS
|
|
1784
|
-
-e, --enterprise=enterprise The name of the enterprise in which to create this asset. (defaults
|
|
1785
|
-
to the current enterprise context)
|
|
1786
|
-
|
|
1787
|
-
-h, --help Show CLI help.
|
|
1788
|
-
|
|
1789
|
-
-n, --name=name The name by which to identify this fileshare definition within the
|
|
1790
|
-
enterprise (Optional: defaults to the shareName).
|
|
1791
|
-
|
|
1792
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the
|
|
1793
|
-
console output.
|
|
1794
|
-
|
|
1795
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values
|
|
1796
|
-
that are remembered from prior runs. Requires: enterprise,name,storag
|
|
1797
|
-
eAccount,shareName,providerSubscriptionId,resourceId,accessKey
|
|
1798
|
-
|
|
1799
|
-
--as=as Fires this command with an argument list that was previously
|
|
1800
|
-
remembered using the --rememberAs flag.
|
|
1801
|
-
|
|
1802
|
-
--providerSubscriptionId=providerSubscriptionId The identifier of the cloud provider subscription under which the
|
|
1803
|
-
file storage account resides.
|
|
1804
|
-
|
|
1805
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this
|
|
1806
|
-
command gets called.
|
|
1807
|
-
|
|
1808
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1809
|
-
|
|
1810
|
-
--resourceGroup=resourceGroup The name of the Azure resource group under which the instance is to
|
|
1811
|
-
be created (Azure-specific).
|
|
1812
|
-
|
|
1813
|
-
--shareName=shareName The name of the fileshare to connect to within the file storage
|
|
1814
|
-
account.
|
|
1815
|
-
|
|
1816
|
-
--storageAccount=storageAccount The name within the cloud provider of the file storage account within
|
|
1817
|
-
which the share resides.
|
|
1818
|
-
|
|
1819
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears
|
|
1820
|
-
the arguments that were previously stored under the given name (use
|
|
1821
|
-
"--unRemember default" to clear default argument list memorized with
|
|
1822
|
-
the --remember flag).
|
|
1823
|
-
|
|
1824
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this
|
|
1825
|
-
call.
|
|
1826
|
-
|
|
1827
|
-
ALIASES
|
|
1828
|
-
$ codiac fileshare:capture
|
|
1829
|
-
```
|
|
1830
|
-
|
|
1831
|
-
_See code: [src/commands/filestore/capture.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/filestore/capture.ts)_
|
|
1832
|
-
|
|
1833
|
-
## `codiac help [COMMAND]`
|
|
1834
|
-
|
|
1835
|
-
display help for codiac
|
|
1836
|
-
|
|
1837
|
-
```
|
|
1838
|
-
USAGE
|
|
1839
|
-
$ codiac help [COMMAND]
|
|
1840
|
-
|
|
1841
|
-
ARGUMENTS
|
|
1842
|
-
COMMAND command to show help for
|
|
1843
|
-
|
|
1844
|
-
OPTIONS
|
|
1845
|
-
--all see all commands in CLI
|
|
1846
|
-
```
|
|
1847
|
-
|
|
1848
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.18/src/commands/help.ts)_
|
|
1849
|
-
|
|
1850
|
-
## `codiac host:map [DOMAIN]`
|
|
1851
|
-
|
|
1852
|
-
Declares a strategy for mapping assets to ingress routes for a domain name.
|
|
1853
|
-
|
|
1854
|
-
```
|
|
1855
|
-
USAGE
|
|
1856
|
-
$ codiac host:map [DOMAIN]
|
|
1857
|
-
|
|
1858
|
-
ARGUMENTS
|
|
1859
|
-
DOMAIN The domain name to route (eg: "my-company.com")
|
|
1860
|
-
|
|
1861
|
-
OPTIONS
|
|
1862
|
-
-c, --cabinet=cabinet The name of the cabinet on which to apply this naming strategy. Must be qualified by
|
|
1863
|
-
also setting enterprise. NOTE: You can leave this blank if there is only one. If
|
|
1864
|
-
cabinet names are not unique, use the --enterprise/-e argument to fully qualify the
|
|
1865
|
-
cabinet name.
|
|
1866
|
-
|
|
1867
|
-
-e, --enterprise=enterprise The name of the enterprise on which to apply this naming strategy. NOTE: You can leave
|
|
1868
|
-
this blank if there is only one.
|
|
1869
|
-
|
|
1870
|
-
-h, --help Show CLI help.
|
|
1871
|
-
|
|
1872
|
-
-n, --naming=naming The host naming strategy to apply.
|
|
1873
|
-
|
|
1874
|
-
-v, --environment=environment The name of the environment on which to apply this naming strategy. Must be qualified
|
|
1875
|
-
by also setting enterprise. NOTE: You can leave this blank if there is only one.
|
|
1876
|
-
|
|
1877
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1878
|
-
|
|
1879
|
-
-x, --noninteractive Throws errors if user interaction is required.
|
|
1880
|
-
|
|
1881
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1882
|
-
--rememberAs flag.
|
|
1883
|
-
|
|
1884
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1885
|
-
|
|
1886
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1887
|
-
|
|
1888
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments
|
|
1889
|
-
that were previously stored under the given name (use "--unRemember default" to clear
|
|
1890
|
-
default argument list memorized with the --remember flag).
|
|
1891
|
-
|
|
1892
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1893
|
-
|
|
1894
|
-
ALIASES
|
|
1895
|
-
$ codiac domain:map
|
|
1896
|
-
```
|
|
1897
|
-
|
|
1898
|
-
_See code: [src/commands/host/map.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/host/map.ts)_
|
|
1899
|
-
|
|
1900
|
-
## `codiac identity [TOKENNAME]`
|
|
1901
|
-
|
|
1902
|
-
Stores an identity token for the current user, for use with a component tool (such as npm). This command acts as an upsert.
|
|
1903
|
-
|
|
1904
|
-
```
|
|
1905
|
-
USAGE
|
|
1906
|
-
$ codiac identity [TOKENNAME]
|
|
1907
|
-
|
|
1908
|
-
ARGUMENTS
|
|
1909
|
-
TOKENNAME (optional) Conventional name (token_for_[provider]_[scope]) for the tokenized identity. This name will
|
|
1910
|
-
also be used for the build environment variable carrying the token.
|
|
1911
|
-
|
|
1912
|
-
OPTIONS
|
|
1913
|
-
-e, --email=email (Azure Artifacts [aka: azart] only) The email address for this identity. Npm
|
|
1914
|
-
requires for this, but never uses it.
|
|
1915
|
-
|
|
1916
|
-
-f, --feed=feed (Azure Artifacts [aka: azart] only) The human readable identifier for the package
|
|
1917
|
-
feed
|
|
1918
|
-
|
|
1919
|
-
-g, --organization=organization (Azure Artifacts [aka: azart] only) Human readable identifier for the organization
|
|
1920
|
-
account with the provider.
|
|
1921
|
-
|
|
1922
|
-
-h, --help Renders the help document for this command.
|
|
1923
|
-
|
|
1924
|
-
-p, --provider=(npm|azart|other) [default: npm] The source of the token.
|
|
1925
|
-
|
|
1926
|
-
-r, --registryUrl=registryUrl The component tool that issued and can consume the token.
|
|
1927
|
-
|
|
1928
|
-
-s, --scope=scope The subdivision within the registry for which this token is honored.
|
|
1929
|
-
|
|
1930
|
-
-t, --token=token (required) The actual raw token string itself issued by the provider
|
|
1931
|
-
|
|
1932
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1933
|
-
|
|
1934
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1935
|
-
--rememberAs flag.
|
|
1936
|
-
|
|
1937
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets
|
|
1938
|
-
called.
|
|
1939
|
-
|
|
1940
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1941
|
-
|
|
1942
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments
|
|
1943
|
-
that were previously stored under the given name (use "--unRemember default" to
|
|
1944
|
-
clear default argument list memorized with the --remember flag).
|
|
1945
|
-
|
|
1946
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1947
|
-
|
|
1948
|
-
ALIASES
|
|
1949
|
-
$ codiac identify
|
|
1950
|
-
$ codiac token
|
|
1951
|
-
```
|
|
1952
|
-
|
|
1953
|
-
_See code: [src/commands/identity.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/identity.ts)_
|
|
1954
|
-
|
|
1955
|
-
## `codiac identity:delete [NAME]`
|
|
1956
|
-
|
|
1957
|
-
Removes an identity token from storage for the current user.
|
|
1958
|
-
|
|
1959
|
-
```
|
|
1960
|
-
USAGE
|
|
1961
|
-
$ codiac identity:delete [NAME]
|
|
1962
|
-
|
|
1963
|
-
ARGUMENTS
|
|
1964
|
-
NAME The name of the token to delete. Use the 'identity:list' command to view the currently stored tokens.
|
|
1965
|
-
|
|
1966
|
-
OPTIONS
|
|
1967
|
-
-h, --help Displays the help document for this command.
|
|
1968
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
1969
|
-
|
|
1970
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
1971
|
-
--rememberAs flag.
|
|
1972
|
-
|
|
1973
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
1974
|
-
|
|
1975
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
1976
|
-
|
|
1977
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
1978
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
1979
|
-
list memorized with the --remember flag).
|
|
1980
|
-
|
|
1981
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
1982
|
-
|
|
1983
|
-
ALIASES
|
|
1984
|
-
$ codiac identity:remove
|
|
1985
|
-
$ codiac token:delete
|
|
1986
|
-
$ codiac token:remove
|
|
1987
|
-
```
|
|
1988
|
-
|
|
1989
|
-
_See code: [src/commands/identity/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/identity/delete.ts)_
|
|
1990
|
-
|
|
1991
|
-
## `codiac identity:list`
|
|
1992
|
-
|
|
1993
|
-
Lists out the identity tokens currently stored for the current user.
|
|
1994
|
-
|
|
1995
|
-
```
|
|
1996
|
-
USAGE
|
|
1997
|
-
$ codiac identity:list
|
|
1998
|
-
|
|
1999
|
-
OPTIONS
|
|
2000
|
-
-h, --help Displays the help document for this command.
|
|
2001
|
-
-o, --output=(table|extended|json|csv) [default: table] Format for the response data.
|
|
2002
|
-
|
|
2003
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
2004
|
-
output.
|
|
2005
|
-
|
|
2006
|
-
--as=as Fires this command with an argument list that was previously remembered using
|
|
2007
|
-
the --rememberAs flag.
|
|
2008
|
-
|
|
2009
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command
|
|
2010
|
-
gets called.
|
|
2011
|
-
|
|
2012
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2013
|
-
|
|
2014
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
2015
|
-
arguments that were previously stored under the given name (use "--unRemember
|
|
2016
|
-
default" to clear default argument list memorized with the --remember flag).
|
|
2017
|
-
|
|
2018
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2019
|
-
|
|
2020
|
-
ALIASES
|
|
2021
|
-
$ codiac token:list
|
|
2022
|
-
```
|
|
2023
|
-
|
|
2024
|
-
_See code: [src/commands/identity/list.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/identity/list.ts)_
|
|
2025
|
-
|
|
2026
|
-
## `codiac imageRegistry:capture`
|
|
2027
|
-
|
|
2028
|
-
Upserts the primary and secondary pull secret references for the given container registry.
|
|
2029
|
-
|
|
2030
|
-
```
|
|
2031
|
-
USAGE
|
|
2032
|
-
$ codiac imageRegistry:capture
|
|
2033
|
-
|
|
2034
|
-
OPTIONS
|
|
2035
|
-
-h, --help Show CLI help.
|
|
2036
|
-
|
|
2037
|
-
-l, --location=location The data center in which the registry resides (use the code name, eg: in
|
|
2038
|
-
Aws use 'us-east-1', NOT 'Virginia, US').
|
|
2039
|
-
|
|
2040
|
-
-n, --name=name The resource name of the container registry within the cloud provider
|
|
2041
|
-
subscription.
|
|
2042
|
-
|
|
2043
|
-
-p, --provider=(aws|azure|dockerHub|other) The cloud provider hosting the container registry.
|
|
2044
|
-
|
|
2045
|
-
-s, --subscriptionId=subscriptionId The id of the cloud provider account in which the registry resides.
|
|
2046
|
-
|
|
2047
|
-
-u, --url=url The container registry url.
|
|
2048
|
-
|
|
2049
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the
|
|
2050
|
-
console output.
|
|
2051
|
-
|
|
2052
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that
|
|
2053
|
-
are remembered from prior runs. Requires:
|
|
2054
|
-
registry,storeType,storeName,name
|
|
2055
|
-
|
|
2056
|
-
-z, --toScript Outputs an assembled command string, NO execution
|
|
2057
|
-
|
|
2058
|
-
--as=as Fires this command with an argument list that was previously remembered
|
|
2059
|
-
using the --rememberAs flag.
|
|
2060
|
-
|
|
2061
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command
|
|
2062
|
-
gets called.
|
|
2063
|
-
|
|
2064
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2065
|
-
|
|
2066
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
2067
|
-
arguments that were previously stored under the given name (use
|
|
2068
|
-
"--unRemember default" to clear default argument list memorized with the
|
|
2069
|
-
--remember flag).
|
|
2070
|
-
|
|
2071
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2072
|
-
|
|
2073
|
-
ALIASES
|
|
2074
|
-
$ codiac pullsecret:unset
|
|
2075
|
-
```
|
|
2076
|
-
|
|
2077
|
-
_See code: [src/commands/imageRegistry/capture.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/imageRegistry/capture.ts)_
|
|
2078
|
-
|
|
2079
|
-
## `codiac imageRegistry:forget`
|
|
2080
|
-
|
|
2081
|
-
Removes the reference to the given container registry for the tenant. Does NOT delete the registry itself.
|
|
2082
|
-
|
|
2083
|
-
```
|
|
2084
|
-
USAGE
|
|
2085
|
-
$ codiac imageRegistry:forget
|
|
2086
|
-
|
|
2087
|
-
OPTIONS
|
|
2088
|
-
-h, --help Show CLI help.
|
|
2089
|
-
-r, --registry=registry The container registry to forget.
|
|
2090
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
2091
|
-
|
|
2092
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
|
|
2093
|
-
prior runs. Requires: registry
|
|
2094
|
-
|
|
2095
|
-
-z, --toScript Outputs an assembled command string, NO execution
|
|
2096
|
-
|
|
2097
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
2098
|
-
--rememberAs flag.
|
|
2099
|
-
|
|
2100
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
2101
|
-
|
|
2102
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2103
|
-
|
|
2104
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
2105
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
2106
|
-
list memorized with the --remember flag).
|
|
2107
|
-
|
|
2108
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2109
|
-
```
|
|
2110
|
-
|
|
2111
|
-
_See code: [src/commands/imageRegistry/forget.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/imageRegistry/forget.ts)_
|
|
2112
|
-
|
|
2113
|
-
## `codiac imageRegistry:pullSecret:set`
|
|
2114
|
-
|
|
2115
|
-
Upserts the primary and secondary pull secret references for the given container registry.
|
|
2116
|
-
|
|
2117
|
-
```
|
|
2118
|
-
USAGE
|
|
2119
|
-
$ codiac imageRegistry:pullSecret:set
|
|
2120
|
-
|
|
2121
|
-
OPTIONS
|
|
2122
|
-
-f, --item=(primary|secondary)
|
|
2123
|
-
[default: primary] Applies the command to either the primary (default) or seoncdary secret for the image registry.
|
|
2124
|
-
|
|
2125
|
-
-h, --help
|
|
2126
|
-
Show CLI help.
|
|
2127
|
-
|
|
2128
|
-
-n, --name=name
|
|
2129
|
-
The name of the secret within the secret store.
|
|
2130
|
-
|
|
2131
|
-
-r, --registry=registry
|
|
2132
|
-
The container registry in which the image exists (defaults to docker hub).
|
|
2133
|
-
|
|
2134
|
-
-s, --storeName=storeName
|
|
2135
|
-
The name of the secret store containing the actual pull secrets.
|
|
2136
|
-
|
|
2137
|
-
-t, --storeType=(awsKeyVault|azBlob|azKeyVault|etcd|mongoCollection|mongoDocument)
|
|
2138
|
-
The type of secret store containing the actual pull secrets.
|
|
2139
|
-
|
|
2140
|
-
-v, --verbose
|
|
2141
|
-
Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
2142
|
-
|
|
2143
|
-
-y, --silent
|
|
2144
|
-
(Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs. Requires:
|
|
2145
|
-
registry,storeType,storeName,name
|
|
2146
|
-
|
|
2147
|
-
-z, --toScript
|
|
2148
|
-
Outputs an assembled command string, NO execution
|
|
2149
|
-
|
|
2150
|
-
--as=as
|
|
2151
|
-
Fires this command with an argument list that was previously remembered using the --rememberAs flag.
|
|
2152
|
-
|
|
2153
|
-
--remember
|
|
2154
|
-
Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
2155
|
-
|
|
2156
|
-
--rememberAs=rememberAs
|
|
2157
|
-
Saves the given argument list so that it can be called by name.
|
|
2158
|
-
|
|
2159
|
-
--unremember=unremember
|
|
2160
|
-
Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were previously stored
|
|
2161
|
-
under the given name (use "--unRemember default" to clear default argument list memorized with the --remember flag).
|
|
2162
|
-
|
|
2163
|
-
--withoutdefaults
|
|
2164
|
-
Prevents any relevant saved defaults from being invoked for this call.
|
|
2165
|
-
|
|
2166
|
-
ALIASES
|
|
2167
|
-
$ codiac pullsecret
|
|
2168
|
-
```
|
|
2169
|
-
|
|
2170
|
-
_See code: [src/commands/imageRegistry/pullSecret/set.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/imageRegistry/pullSecret/set.ts)_
|
|
2171
|
-
|
|
2172
|
-
## `codiac imageRegistry:pullSecret:unset`
|
|
2173
|
-
|
|
2174
|
-
Removes the primary or secondary pull secret reference for the given container registry.
|
|
2175
|
-
|
|
2176
|
-
```
|
|
2177
|
-
USAGE
|
|
2178
|
-
$ codiac imageRegistry:pullSecret:unset
|
|
2179
|
-
|
|
2180
|
-
OPTIONS
|
|
2181
|
-
-f, --item=(primary|secondary) [default: primary] Applies the command to either the primary (default) or seoncdary
|
|
2182
|
-
secret for the image registry.
|
|
2183
|
-
|
|
2184
|
-
-h, --help Show CLI help.
|
|
2185
|
-
|
|
2186
|
-
-r, --registry=registry The container registry in which the image exists (defaults to docker hub).
|
|
2187
|
-
|
|
2188
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
2189
|
-
|
|
2190
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are
|
|
2191
|
-
remembered from prior runs. Requires: registry,storeType,storeName,name
|
|
2192
|
-
|
|
2193
|
-
-z, --toScript Outputs an assembled command string, NO execution
|
|
2194
|
-
|
|
2195
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
2196
|
-
--rememberAs flag.
|
|
2197
|
-
|
|
2198
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets
|
|
2199
|
-
called.
|
|
2200
|
-
|
|
2201
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2202
|
-
|
|
2203
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments
|
|
2204
|
-
that were previously stored under the given name (use "--unRemember default" to clear
|
|
2205
|
-
default argument list memorized with the --remember flag).
|
|
2206
|
-
|
|
2207
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2208
|
-
|
|
2209
|
-
ALIASES
|
|
2210
|
-
$ codiac pullsecret:unset
|
|
2211
|
-
```
|
|
2212
|
-
|
|
2213
|
-
_See code: [src/commands/imageRegistry/pullSecret/unset.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/imageRegistry/pullSecret/unset.ts)_
|
|
2214
|
-
|
|
2215
|
-
## `codiac images:add [IMAGENAME]`
|
|
2216
|
-
|
|
2217
|
-
Configures a container image to be built and published by the project.
|
|
2218
|
-
|
|
2219
|
-
```
|
|
2220
|
-
USAGE
|
|
2221
|
-
$ codiac images:add [IMAGENAME]
|
|
2222
|
-
|
|
2223
|
-
ARGUMENTS
|
|
2224
|
-
IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
|
|
2225
|
-
|
|
2226
|
-
OPTIONS
|
|
2227
|
-
-b, --buildParams=buildParams
|
|
2228
|
-
Additional freeform arguments to apply to the Docker build command.
|
|
2229
|
-
|
|
2230
|
-
-e, --environment=environment
|
|
2231
|
-
(optional) Declaration that this registry shall be the target when publishing to the given environment.
|
|
2232
|
-
|
|
2233
|
-
-f, --sourceFile=sourceFile
|
|
2234
|
-
Path and filename of the image definition file, relative to the project root, (eg: "./Dockerfile"). If omitted, the
|
|
2235
|
-
build will use an in-memory image definition auto-generated at build time.
|
|
2236
|
-
|
|
2237
|
-
-h, --help
|
|
2238
|
-
Show CLI help.
|
|
2239
|
-
|
|
2240
|
-
-i, --infoUrl=infoUrl
|
|
2241
|
-
(Optional) Address on the registry website or portal of the human-readable web page for the image.
|
|
2242
|
-
|
|
2243
|
-
-p, --port=port
|
|
2244
|
-
Recommended port number to assign, in the toybox template, to an Asset defined by this image.
|
|
2245
|
-
|
|
2246
|
-
-r, --registryUrl=registryUrl
|
|
2247
|
-
[default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the container registry to which
|
|
2248
|
-
the image will be published (without protocol prefix), eg: "yourimages.azurecr.io". NOTE: This registry will be
|
|
2249
|
-
used by the "publish" command, whereas when running in "local" mode, images will instead be registered to the
|
|
2250
|
-
built-in image registry on the local machine. NOTE: This url shall define the default publishing target, for use
|
|
2251
|
-
when publishing for any environment, unless otherwise specified.
|
|
2252
|
-
|
|
2253
|
-
-s, --password=password
|
|
2254
|
-
(optional) Password credential for the given registry. WARNING!! these username/password credentials will be stored
|
|
2255
|
-
in the codiac config file in this project, and therefore configuring username and password in this manner is not
|
|
2256
|
-
recommended!
|
|
2257
|
-
|
|
2258
|
-
-u, --username=username
|
|
2259
|
-
(optional) Login credential for the given registry. WARNING!! these username/password credentials will be stored in
|
|
2260
|
-
the codiac config file in this project, and therefore configuring username and password in this manner is not
|
|
2261
|
-
recommended!
|
|
2262
|
-
|
|
2263
|
-
-v, --verbose
|
|
2264
|
-
Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
2265
|
-
|
|
2266
|
-
-y, --silent
|
|
2267
|
-
(Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs. Requires:
|
|
2268
|
-
registryUrl,port,sourceFile,username,name
|
|
2269
|
-
|
|
2270
|
-
--as=as
|
|
2271
|
-
Fires this command with an argument list that was previously remembered using the --rememberAs flag.
|
|
2272
|
-
|
|
2273
|
-
--remember
|
|
2274
|
-
Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
2275
|
-
|
|
2276
|
-
--rememberAs=rememberAs
|
|
2277
|
-
Saves the given argument list so that it can be called by name.
|
|
2278
|
-
|
|
2279
|
-
--unremember=unremember
|
|
2280
|
-
Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were previously stored
|
|
2281
|
-
under the given name (use "--unRemember default" to clear default argument list memorized with the --remember flag).
|
|
2282
|
-
|
|
2283
|
-
--withoutdefaults
|
|
2284
|
-
Prevents any relevant saved defaults from being invoked for this call.
|
|
2285
|
-
|
|
2286
|
-
ALIASES
|
|
2287
|
-
$ codiac image
|
|
2288
|
-
$ codiac image:add
|
|
2289
|
-
$ codiac img
|
|
2290
|
-
$ codiac img:add
|
|
2291
|
-
```
|
|
2292
|
-
|
|
2293
|
-
_See code: [src/commands/images/add.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/images/add.ts)_
|
|
2294
|
-
|
|
2295
|
-
## `codiac images:list [HELLO]`
|
|
2296
|
-
|
|
2297
|
-
Renders the list of container images that are configured as project exports.
|
|
2298
|
-
|
|
2299
|
-
```
|
|
2300
|
-
USAGE
|
|
2301
|
-
$ codiac images:list [HELLO]
|
|
2302
|
-
|
|
2303
|
-
OPTIONS
|
|
2304
|
-
-h, --help Show CLI help.
|
|
2305
|
-
-o, --output=(table|extended|json|csv) [default: table] Format for the response data.
|
|
2306
|
-
|
|
2307
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
2308
|
-
output.
|
|
2309
|
-
|
|
2310
|
-
--as=as Fires this command with an argument list that was previously remembered using
|
|
2311
|
-
the --rememberAs flag.
|
|
2312
|
-
|
|
2313
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command
|
|
2314
|
-
gets called.
|
|
2315
|
-
|
|
2316
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2317
|
-
|
|
2318
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
2319
|
-
arguments that were previously stored under the given name (use "--unRemember
|
|
2320
|
-
default" to clear default argument list memorized with the --remember flag).
|
|
2321
|
-
|
|
2322
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2323
|
-
|
|
2324
|
-
ALIASES
|
|
2325
|
-
$ codiac image:list
|
|
2326
|
-
$ codiac img:list
|
|
2327
|
-
```
|
|
2328
|
-
|
|
2329
|
-
_See code: [src/commands/images/list.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/images/list.ts)_
|
|
2330
|
-
|
|
2331
|
-
## `codiac images:patch IMAGENAME`
|
|
2332
|
-
|
|
2333
|
-
Applies the given values to an existing image export configuration. Both registryUrl and environment act as filters to limit the operation. That is, an upsert of registry targets is performed for the given image, based on the given registryUrl and/or environment.
|
|
2334
|
-
|
|
2335
|
-
```
|
|
2336
|
-
USAGE
|
|
2337
|
-
$ codiac images:patch IMAGENAME
|
|
2338
|
-
|
|
2339
|
-
ARGUMENTS
|
|
2340
|
-
IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
|
|
2341
|
-
|
|
2342
|
-
OPTIONS
|
|
2343
|
-
-h, --help Show CLI help.
|
|
2344
|
-
|
|
2345
|
-
-s, --set=set Space-delimited list of key-value pairs tp apply with json-path on the left and the desired
|
|
2346
|
-
value on the right. (eg: --set .targets.default.registryUrl=mystuff.azurecr.io)
|
|
2347
|
-
|
|
2348
|
-
-u, --unset=unset Space-delimited list of properties to clear, in json-path format. (eg: --unset
|
|
2349
|
-
.targets.default)
|
|
2350
|
-
|
|
2351
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
2352
|
-
|
|
2353
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
2354
|
-
--rememberAs flag.
|
|
2355
|
-
|
|
2356
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
2357
|
-
|
|
2358
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2359
|
-
|
|
2360
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
2361
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
2362
|
-
list memorized with the --remember flag).
|
|
2363
|
-
|
|
2364
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2365
|
-
|
|
2366
|
-
ALIASES
|
|
2367
|
-
$ codiac image:patch
|
|
2368
|
-
$ codiac img:patch
|
|
2369
|
-
```
|
|
2370
|
-
|
|
2371
|
-
_See code: [src/commands/images/patch.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/images/patch.ts)_
|
|
2372
|
-
|
|
2373
|
-
## `codiac images:remove IMAGENAME`
|
|
2374
|
-
|
|
2375
|
-
Deletes the given image export from the configuration.
|
|
2376
|
-
|
|
2377
|
-
```
|
|
2378
|
-
USAGE
|
|
2379
|
-
$ codiac images:remove IMAGENAME
|
|
2380
|
-
|
|
2381
|
-
ARGUMENTS
|
|
2382
|
-
IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
|
|
2383
|
-
|
|
2384
|
-
OPTIONS
|
|
2385
|
-
-h, --help Show CLI help.
|
|
2386
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
2387
|
-
|
|
2388
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
2389
|
-
--rememberAs flag.
|
|
2390
|
-
|
|
2391
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
2392
|
-
|
|
2393
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2394
|
-
|
|
2395
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
2396
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
2397
|
-
list memorized with the --remember flag).
|
|
2398
|
-
|
|
2399
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2400
|
-
|
|
2401
|
-
ALIASES
|
|
2402
|
-
$ codiac image:remove
|
|
2403
|
-
$ codiac img:remove
|
|
2404
|
-
$ codiac image:delete
|
|
2405
|
-
$ codiac img:delete
|
|
2406
|
-
```
|
|
2407
|
-
|
|
2408
|
-
_See code: [src/commands/images/remove.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/images/remove.ts)_
|
|
2409
|
-
|
|
2410
|
-
## `codiac images:version [NAME]`
|
|
2411
|
-
|
|
2412
|
-
Output the local version a given image. useful for ci/cd automation.
|
|
2413
|
-
|
|
2414
|
-
```
|
|
2415
|
-
USAGE
|
|
2416
|
-
$ codiac images:version [NAME]
|
|
2417
|
-
|
|
2418
|
-
OPTIONS
|
|
2419
|
-
-h, --help Show CLI help.
|
|
2420
|
-
-o, --output=(stdOut|json) [default: stdOut] Format for the response data.
|
|
2421
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
2422
|
-
|
|
2423
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
2424
|
-
--rememberAs flag.
|
|
2425
|
-
|
|
2426
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
2427
|
-
|
|
2428
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2429
|
-
|
|
2430
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that
|
|
2431
|
-
were previously stored under the given name (use "--unRemember default" to clear default
|
|
2432
|
-
argument list memorized with the --remember flag).
|
|
2433
|
-
|
|
2434
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2435
|
-
|
|
2436
|
-
ALIASES
|
|
2437
|
-
$ codiac image:list
|
|
2438
|
-
$ codiac img:list
|
|
2439
|
-
```
|
|
2440
|
-
|
|
2441
|
-
_See code: [src/commands/images/version.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/images/version.ts)_
|
|
2442
|
-
|
|
2443
|
-
## `codiac init DIRECTORY`
|
|
2444
|
-
|
|
2445
|
-
Declares the given folder as a project root
|
|
2446
|
-
|
|
2447
|
-
```
|
|
2448
|
-
USAGE
|
|
2449
|
-
$ codiac init DIRECTORY
|
|
2450
|
-
|
|
2451
|
-
ARGUMENTS
|
|
2452
|
-
DIRECTORY Path to the desired project root, relative to current directory.
|
|
2453
|
-
|
|
2454
|
-
OPTIONS
|
|
2455
|
-
-c, --clone=clone (Optional) The git repo from which to hydrate the project folder.
|
|
2456
|
-
-h, --help Show CLI help.
|
|
2457
|
-
-t, --projectType=projectType (Optional) The type of Codiac project to scaffold.
|
|
2458
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
2459
|
-
|
|
2460
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
2461
|
-
--rememberAs flag.
|
|
2462
|
-
|
|
2463
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
2464
|
-
|
|
2465
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2466
|
-
|
|
2467
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments
|
|
2468
|
-
that were previously stored under the given name (use "--unRemember default" to clear
|
|
2469
|
-
default argument list memorized with the --remember flag).
|
|
2470
|
-
|
|
2471
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2472
|
-
```
|
|
2473
|
-
|
|
2474
|
-
_See code: [src/commands/init.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/init.ts)_
|
|
2475
|
-
|
|
2476
|
-
## `codiac kit:create [SETTING]`
|
|
2477
|
-
|
|
2478
|
-
Creates a new kit from an existing asset.
|
|
2479
|
-
|
|
2480
|
-
```
|
|
2481
|
-
USAGE
|
|
2482
|
-
$ codiac kit:create [SETTING]
|
|
2483
|
-
|
|
2484
|
-
ARGUMENTS
|
|
2485
|
-
SETTING The key for the config setting to add
|
|
2486
|
-
|
|
2487
|
-
OPTIONS
|
|
2488
|
-
-a, --asset=asset The enterprise asset from which to create the kit.
|
|
2489
|
-
|
|
2490
|
-
-e, --enterprise=enterprise The name of the enterprise containing the given asset. (defaults to the current
|
|
2491
|
-
enterprise context)
|
|
2492
|
-
|
|
2493
|
-
-h, --help Show CLI help.
|
|
2494
|
-
|
|
2495
|
-
-n, --name=name Override for the name to give the new kit (Optional: defaults to the asset name).
|
|
2496
|
-
|
|
2497
|
-
-s, --scope=scope The globally unique name for the directory in which to register the kit. This value
|
|
2498
|
-
prefixes the kit name to ensure global uniqueness (Optional: defaults to the public
|
|
2499
|
-
shared library).
|
|
2500
|
-
|
|
2501
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
2502
|
-
|
|
2503
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered
|
|
2504
|
-
from prior runs. Requires:
|
|
2505
|
-
asset,enterprise,name,code,enterprise,port,hasIngress,routedWithoutName
|
|
2506
|
-
|
|
2507
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
2508
|
-
--rememberAs flag.
|
|
2509
|
-
|
|
2510
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
2511
|
-
|
|
2512
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2513
|
-
|
|
2514
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that
|
|
2515
|
-
were previously stored under the given name (use "--unRemember default" to clear default
|
|
2516
|
-
argument list memorized with the --remember flag).
|
|
2517
|
-
|
|
2518
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2519
|
-
```
|
|
2520
|
-
|
|
2521
|
-
_See code: [src/commands/kit/create.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/kit/create.ts)_
|
|
2522
|
-
|
|
2523
|
-
## `codiac login`
|
|
2524
|
-
|
|
2525
|
-
Codiac system login to authenticate user under a tenant.
|
|
2526
|
-
|
|
2527
|
-
```
|
|
2528
|
-
USAGE
|
|
2529
|
-
$ codiac login
|
|
2530
|
-
|
|
2531
|
-
OPTIONS
|
|
2532
|
-
-h, --help Show CLI help.
|
|
2533
|
-
|
|
2534
|
-
-i, --passwordIn Reads the password directly from the standard input stream. Enables users to avoid
|
|
2535
|
-
explicitly rendering it in a command string. eg: `cat mypass.txt | cod login -u joecool
|
|
2536
|
-
--passwordIn`. Invokes `--silent` mode, so interaction will be disabled.
|
|
2537
|
-
|
|
2538
|
-
-o, --tokenOut Writes the token as the sole stdout content (so that it is available to be piped or
|
|
2539
|
-
redirected elsewhere, eg `cod login > mycodiactoken.txt`). Leaves stdout empty on
|
|
2540
|
-
errors. Invokes `--silent` mode, so interaction will be disabled.
|
|
2541
|
-
|
|
2542
|
-
-p, --password=password password on Codiac
|
|
2543
|
-
|
|
2544
|
-
-t, --tenantCode=tenantCode Human-readable Identifier for the Codiac tenant to log in under (optional: defaults to
|
|
2545
|
-
the tenant code for the current project or prompts you to select one from your profile).
|
|
2546
|
-
|
|
2547
|
-
-u, --username=username Username on Codiac
|
|
2548
|
-
|
|
2549
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
2550
|
-
|
|
2551
|
-
-y, --silent (Optional: defaults to false) Prevents interactive user-interface and throws if
|
|
2552
|
-
interaction is needed. Requires arguments: [--username -u, --passwordIn -i]
|
|
2553
|
-
|
|
2554
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
2555
|
-
--rememberAs flag.
|
|
2556
|
-
|
|
2557
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
2558
|
-
|
|
2559
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2560
|
-
|
|
2561
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that
|
|
2562
|
-
were previously stored under the given name (use "--unRemember default" to clear default
|
|
2563
|
-
argument list memorized with the --remember flag).
|
|
2564
|
-
|
|
2565
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2566
|
-
|
|
2567
|
-
ALIASES
|
|
2568
|
-
$ codiac user:login
|
|
2569
|
-
```
|
|
2570
|
-
|
|
2571
|
-
_See code: [src/commands/login.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/login.ts)_
|
|
2572
|
-
|
|
2573
|
-
## `codiac logout`
|
|
2574
|
-
|
|
2575
|
-
Resets the current user to anonymous and clears any local user cache.
|
|
2576
|
-
|
|
2577
|
-
```
|
|
2578
|
-
USAGE
|
|
2579
|
-
$ codiac logout
|
|
2580
|
-
|
|
2581
|
-
OPTIONS
|
|
2582
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
2583
|
-
|
|
2584
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
2585
|
-
--rememberAs flag.
|
|
2586
|
-
|
|
2587
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
2588
|
-
|
|
2589
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2590
|
-
|
|
2591
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
2592
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
2593
|
-
list memorized with the --remember flag).
|
|
2594
|
-
|
|
2595
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2596
|
-
|
|
2597
|
-
EXAMPLE
|
|
2598
|
-
codiac logout
|
|
2599
|
-
```
|
|
2600
|
-
|
|
2601
|
-
_See code: [src/commands/logout.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/logout.ts)_
|
|
2602
|
-
|
|
2603
|
-
## `codiac merge [BRANCH]`
|
|
2604
|
-
|
|
2605
|
-
Merges the given branch into the current branch of the main project and on any sourced dependencies.
|
|
2606
|
-
|
|
2607
|
-
```
|
|
2608
|
-
USAGE
|
|
2609
|
-
$ codiac merge [BRANCH]
|
|
2610
|
-
|
|
2611
|
-
ARGUMENTS
|
|
2612
|
-
BRANCH The branch name to merge into the current one.
|
|
2613
|
-
|
|
2614
|
-
OPTIONS
|
|
2615
|
-
-c, --commit Commits if merge succeeds.
|
|
2616
|
-
-h, --help Show CLI help.
|
|
2617
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
2618
|
-
|
|
2619
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
2620
|
-
--rememberAs flag.
|
|
2621
|
-
|
|
2622
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
2623
|
-
|
|
2624
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2625
|
-
|
|
2626
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
2627
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
2628
|
-
list memorized with the --remember flag).
|
|
2629
|
-
|
|
2630
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2631
|
-
```
|
|
2632
|
-
|
|
2633
|
-
_See code: [src/commands/merge.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/merge.ts)_
|
|
2634
|
-
|
|
2635
|
-
## `codiac noc:cluster:create [NAME]`
|
|
2636
|
-
|
|
2637
|
-
Provisions the physical cluster
|
|
2638
|
-
|
|
2639
|
-
```
|
|
2640
|
-
USAGE
|
|
2641
|
-
$ codiac noc:cluster:create [NAME]
|
|
2642
|
-
|
|
2643
|
-
ARGUMENTS
|
|
2644
|
-
NAME Proposed name of the cluster
|
|
2645
|
-
|
|
2646
|
-
OPTIONS
|
|
2647
|
-
-g, --resourceGroup=resourceGroup The Azure resource group to create for the cluster.
|
|
2648
|
-
-h, --help Show CLI help.
|
|
2649
|
-
-k, --subnet=subnet The resource id of the subnet in which the cluster is to be created.
|
|
2650
|
-
|
|
2651
|
-
-l, --location=location The short name of the azure data center in which the cliuster is to
|
|
2652
|
-
reside.
|
|
2653
|
-
|
|
2654
|
-
-n, --nodeSpec=nodeSpec The identifier for the type of VM to use for nodes in the cluster.
|
|
2655
|
-
|
|
2656
|
-
-p, --owner=owner Tenant code of the private owner of the cluster
|
|
2657
|
-
|
|
2658
|
-
-q, --nodeQty=nodeQty The starting node count with which to create the cluster.
|
|
2659
|
-
|
|
2660
|
-
-s, --providerSubscription=providerSubscription The Azure subscription Id under which to create the cluster.
|
|
2661
|
-
|
|
2662
|
-
-t, --toScript Outputs an assembled command string, NO execution
|
|
2663
|
-
|
|
2664
|
-
-u, --identityUserId=identityUserId OPTIONAL. ID of Svc Principal or Managed Identity to execute as. To
|
|
2665
|
-
create k8s cluster, IP address, and container Pull. If none supplied
|
|
2666
|
-
Codiac will try to create one.
|
|
2667
|
-
|
|
2668
|
-
-u, --identityUserName=identityUserName OPTIONAL. Name of Svc Principal or Managed Identity to execute as. To
|
|
2669
|
-
create k8s cluster, IP address, and container Pull. If none supplied
|
|
2670
|
-
Codiac will try to create one.
|
|
2671
|
-
|
|
2672
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the
|
|
2673
|
-
console output.
|
|
2674
|
-
|
|
2675
|
-
-y, --silent=silent (Optional: defaults to false) Prevents confirmations of user-values.
|
|
2676
|
-
Required:
|
|
2677
|
-
providerSubscription,resourceGroup,location,nodeSpec,nodeQty
|
|
2678
|
-
|
|
2679
|
-
--as=as Fires this command with an argument list that was previously
|
|
2680
|
-
remembered using the --rememberAs flag.
|
|
2681
|
-
|
|
2682
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this
|
|
2683
|
-
command gets called.
|
|
2684
|
-
|
|
2685
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2686
|
-
|
|
2687
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears
|
|
2688
|
-
the arguments that were previously stored under the given name (use
|
|
2689
|
-
"--unRemember default" to clear default argument list memorized with
|
|
2690
|
-
the --remember flag).
|
|
2691
|
-
|
|
2692
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this
|
|
2693
|
-
call.
|
|
2694
|
-
|
|
2695
|
-
ALIASES
|
|
2696
|
-
$ codiac cluster:create
|
|
2697
|
-
```
|
|
2698
|
-
|
|
2699
|
-
_See code: [src/commands/noc/cluster/create.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/noc/cluster/create.ts)_
|
|
2700
|
-
|
|
2701
|
-
## `codiac noc:cluster:deinit [NAME]`
|
|
2702
|
-
|
|
2703
|
-
Deinitialization of the cluster (uninstalls the ingress controller and tls cert manager services)
|
|
2704
|
-
|
|
2705
|
-
```
|
|
2706
|
-
USAGE
|
|
2707
|
-
$ codiac noc:cluster:deinit [NAME]
|
|
2708
|
-
|
|
2709
|
-
ARGUMENTS
|
|
2710
|
-
NAME Name of existing cluster.
|
|
2711
|
-
|
|
2712
|
-
OPTIONS
|
|
2713
|
-
-h, --help Show CLI help.
|
|
2714
|
-
-n, --name=name Name of the cluster.
|
|
2715
|
-
-p, --provider=(aws|azure|dockerHub|other) Code for the cloud service provider.
|
|
2716
|
-
|
|
2717
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the
|
|
2718
|
-
console output.
|
|
2719
|
-
|
|
2720
|
-
-y, --silent (Optional: defaults to false) Prevents interactive user-interface and
|
|
2721
|
-
throws if interaction is needed. Requires arguments: [--name -n]
|
|
2722
|
-
|
|
2723
|
-
--as=as Fires this command with an argument list that was previously remembered
|
|
2724
|
-
using the --rememberAs flag.
|
|
2725
|
-
|
|
2726
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command
|
|
2727
|
-
gets called.
|
|
2728
|
-
|
|
2729
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2730
|
-
|
|
2731
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
2732
|
-
arguments that were previously stored under the given name (use
|
|
2733
|
-
"--unRemember default" to clear default argument list memorized with the
|
|
2734
|
-
--remember flag).
|
|
2735
|
-
|
|
2736
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2737
|
-
|
|
2738
|
-
ALIASES
|
|
2739
|
-
$ codiac cluster:deinit
|
|
2740
|
-
```
|
|
2741
|
-
|
|
2742
|
-
_See code: [src/commands/noc/cluster/deinit.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/noc/cluster/deinit.ts)_
|
|
2743
|
-
|
|
2744
|
-
## `codiac noc:cluster:destroy [NAME]`
|
|
2745
|
-
|
|
2746
|
-
Kills the physical cluster, but not the Codiac cluster definition record
|
|
2747
|
-
|
|
2748
|
-
```
|
|
2749
|
-
USAGE
|
|
2750
|
-
$ codiac noc:cluster:destroy [NAME]
|
|
2751
|
-
|
|
2752
|
-
ARGUMENTS
|
|
2753
|
-
NAME Proposed name of the cluster
|
|
2754
|
-
|
|
2755
|
-
OPTIONS
|
|
2756
|
-
-h, --help Show CLI help.
|
|
2757
|
-
|
|
2758
|
-
-i, --deleteIdentity (optional: defaults to false) Ensures that identity security account for
|
|
2759
|
-
the cluster shall also be deleted after the cluster itself is destroyed.
|
|
2760
|
-
|
|
2761
|
-
-n, --name=name Name of the cluster.
|
|
2762
|
-
|
|
2763
|
-
-p, --partials Include clusters that were never fully created.
|
|
2764
|
-
|
|
2765
|
-
-p, --provider=(azure|aws|dockerHub|other) Code for the cloud service provider.
|
|
2766
|
-
|
|
2767
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the
|
|
2768
|
-
console output.
|
|
2769
|
-
|
|
2770
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values.
|
|
2771
|
-
Required: name
|
|
2772
|
-
|
|
2773
|
-
--as=as Fires this command with an argument list that was previously remembered
|
|
2774
|
-
using the --rememberAs flag.
|
|
2775
|
-
|
|
2776
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command
|
|
2777
|
-
gets called.
|
|
2778
|
-
|
|
2779
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2780
|
-
|
|
2781
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
2782
|
-
arguments that were previously stored under the given name (use
|
|
2783
|
-
"--unRemember default" to clear default argument list memorized with the
|
|
2784
|
-
--remember flag).
|
|
2785
|
-
|
|
2786
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2787
|
-
|
|
2788
|
-
ALIASES
|
|
2789
|
-
$ codiac cluster:destroy
|
|
2790
|
-
```
|
|
2791
|
-
|
|
2792
|
-
_See code: [src/commands/noc/cluster/destroy.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/noc/cluster/destroy.ts)_
|
|
2793
|
-
|
|
2794
|
-
## `codiac noc:cluster:init [NAME]`
|
|
2795
|
-
|
|
2796
|
-
Post-create initialization for the cluster (installs the ingress controller service)
|
|
2797
|
-
|
|
2798
|
-
```
|
|
2799
|
-
USAGE
|
|
2800
|
-
$ codiac noc:cluster:init [NAME]
|
|
2801
|
-
|
|
2802
|
-
ARGUMENTS
|
|
2803
|
-
NAME Name of existing cluster to initialize.
|
|
2804
|
-
|
|
2805
|
-
OPTIONS
|
|
2806
|
-
-h, --help Show CLI help.
|
|
2807
|
-
-n, --name=name Name of the cluster.
|
|
2808
|
-
-p, --provider=(azure|aws|dockerHub|other) Code for the cloud service provider.
|
|
2809
|
-
|
|
2810
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the
|
|
2811
|
-
console output.
|
|
2812
|
-
|
|
2813
|
-
-y, --silent (Optional: defaults to false) Prevents interactive user-interface and
|
|
2814
|
-
throws if interaction is needed. Requires arguments: [--name -n]
|
|
2815
|
-
|
|
2816
|
-
--as=as Fires this command with an argument list that was previously remembered
|
|
2817
|
-
using the --rememberAs flag.
|
|
2818
|
-
|
|
2819
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command
|
|
2820
|
-
gets called.
|
|
2821
|
-
|
|
2822
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2823
|
-
|
|
2824
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
2825
|
-
arguments that were previously stored under the given name (use
|
|
2826
|
-
"--unRemember default" to clear default argument list memorized with the
|
|
2827
|
-
--remember flag).
|
|
2828
|
-
|
|
2829
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2830
|
-
|
|
2831
|
-
ALIASES
|
|
2832
|
-
$ codiac cluster:init
|
|
2833
|
-
```
|
|
2834
|
-
|
|
2835
|
-
_See code: [src/commands/noc/cluster/init.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/noc/cluster/init.ts)_
|
|
2836
|
-
|
|
2837
|
-
## `codiac noc:cluster:list`
|
|
2838
|
-
|
|
2839
|
-
Shows the list of clusters.
|
|
2840
|
-
|
|
2841
|
-
```
|
|
2842
|
-
USAGE
|
|
2843
|
-
$ codiac noc:cluster:list
|
|
2844
|
-
|
|
2845
|
-
OPTIONS
|
|
2846
|
-
-h, --help Displays the help document for this command.
|
|
2847
|
-
-o, --output=(json|yaml|tree|text) [default: tree] format in which to render the data.
|
|
2848
|
-
|
|
2849
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console
|
|
2850
|
-
output.
|
|
2851
|
-
|
|
2852
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
2853
|
-
--rememberAs flag.
|
|
2854
|
-
|
|
2855
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets
|
|
2856
|
-
called.
|
|
2857
|
-
|
|
2858
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2859
|
-
|
|
2860
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
2861
|
-
arguments that were previously stored under the given name (use "--unRemember
|
|
2862
|
-
default" to clear default argument list memorized with the --remember flag).
|
|
2863
|
-
|
|
2864
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
2865
|
-
|
|
2866
|
-
ALIASES
|
|
2867
|
-
$ codiac cluster:list
|
|
2868
|
-
```
|
|
2869
|
-
|
|
2870
|
-
_See code: [src/commands/noc/cluster/list.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/noc/cluster/list.ts)_
|
|
2871
|
-
|
|
2872
|
-
## `codiac noc:cluster:recreate [NAME]`
|
|
2873
|
-
|
|
2874
|
-
Provisions the physical cluster using the existing ClusterDef record (with any changes provided by the caller).
|
|
2875
|
-
|
|
2876
|
-
```
|
|
2877
|
-
USAGE
|
|
2878
|
-
$ codiac noc:cluster:recreate [NAME]
|
|
2879
|
-
|
|
2880
|
-
ARGUMENTS
|
|
2881
|
-
NAME Name of an existing cluster to re-create
|
|
2882
|
-
|
|
2883
|
-
OPTIONS
|
|
2884
|
-
-g, --resourceGroup=resourceGroup The Azure resource group to create for the cluster.
|
|
2885
|
-
-h, --help Show CLI help.
|
|
2886
|
-
|
|
2887
|
-
-k, --subnet=subnet The resource id of the subnet in which the cluster is to be
|
|
2888
|
-
created.
|
|
2889
|
-
|
|
2890
|
-
-l, --location=location The short name of the azure data center in which the cliuster is to
|
|
2891
|
-
reside.
|
|
2892
|
-
|
|
2893
|
-
-n, --nodeSpec=nodeSpec The identifier for the type of VM to use for nodes in the cluster.
|
|
2894
|
-
|
|
2895
|
-
-p, --owner=owner Tenant code of the private owner of the cluster
|
|
2896
|
-
|
|
2897
|
-
-q, --nodeQty=nodeQty The starting node count with which to create the cluster.
|
|
2898
|
-
|
|
2899
|
-
-s, --providerSubscription=providerSubscription The Azure subscription Id under which to create the cluster.
|
|
2900
|
-
|
|
2901
|
-
-t, --toScript Outputs an assembled command string, NO execution
|
|
2902
|
-
|
|
2903
|
-
-v, --k8sVersion=k8sVersion The Kubernetes version for the new cluster. This must be a
|
|
2904
|
-
supported version from the cloud provider.
|
|
2905
|
-
|
|
2906
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the
|
|
2907
|
-
console output.
|
|
2908
|
-
|
|
2909
|
-
-w, --windowsSupport Add a windows nodepool.
|
|
2910
|
-
|
|
2911
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of
|
|
2912
|
-
user-values. Required:
|
|
2913
|
-
|
|
2914
|
-
--as=as Fires this command with an argument list that was previously
|
|
2915
|
-
remembered using the --rememberAs flag.
|
|
2916
|
-
|
|
2917
|
-
--identityName=identityName name of an existing service principal to use for the cluster
|
|
2918
|
-
identity
|
|
2919
|
-
|
|
2920
|
-
--identityType=(servicePrincipal|managedIdentity) The type of security account to use for the cluster identity.
|
|
2921
|
-
|
|
2922
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this
|
|
2923
|
-
command gets called.
|
|
2924
|
-
|
|
2925
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
2926
|
-
|
|
2927
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply
|
|
2928
|
-
clears the arguments that were previously stored under the given
|
|
2929
|
-
name (use "--unRemember default" to clear default argument list
|
|
2930
|
-
memorized with the --remember flag).
|
|
2931
|
-
|
|
2932
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this
|
|
2933
|
-
call.
|
|
2934
|
-
|
|
2935
|
-
ALIASES
|
|
2936
|
-
$ codiac cluster:recreate
|
|
2937
|
-
```
|
|
2938
|
-
|
|
2939
|
-
_See code: [src/commands/noc/cluster/recreate.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/noc/cluster/recreate.ts)_
|
|
2940
|
-
|
|
2941
|
-
## `codiac pkg:add [DEFINITIONFILE]`
|
|
2942
|
-
|
|
2943
|
-
Configures a package to be built and published by the project.
|
|
2944
|
-
|
|
2945
|
-
```
|
|
2946
|
-
USAGE
|
|
2947
|
-
$ codiac pkg:add [DEFINITIONFILE]
|
|
2948
|
-
|
|
2949
|
-
ARGUMENTS
|
|
2950
|
-
DEFINITIONFILE Path and filename of the package definition file, relative to the codiac project root, (eg:
|
|
2951
|
-
"./package.json")
|
|
2952
|
-
|
|
2953
|
-
OPTIONS
|
|
2954
|
-
-e, --environment=environment
|
|
2955
|
-
(optional) Declaration that this registry shall be the target when publishing to the given environment.
|
|
2956
|
-
|
|
2957
|
-
-h, --help
|
|
2958
|
-
Show CLI help.
|
|
2959
|
-
|
|
2960
|
-
-r, --registryUrl=registryUrl
|
|
2961
|
-
Address of the registry to which the package will be published (without protocol prefix), eg:
|
|
2962
|
-
"yourpackages.azurecr.io". NOTE: This registry will be used by the "codiac publish" command, whereas when running
|
|
2963
|
-
in "local" mode, packages will instead be registered to the built-in package registry on the local machine. NOTE:
|
|
2964
|
-
This url shall define the default publishing target, for use when publishing for any environment, unless otherwise
|
|
2965
|
-
specified.
|
|
2966
|
-
|
|
2967
|
-
-s, --password=password
|
|
2968
|
-
(optional) Password credential for the given registry. WARNING!! these username/password credentials will be stored
|
|
2969
|
-
in the codiac config file in this project, and therefore configuring username and password in this manner is not
|
|
2970
|
-
recommended!
|
|
2971
|
-
|
|
2972
|
-
-u, --username=username
|
|
2973
|
-
(optional) Login credential for the given registry. WARNING!! these username/password credentials will be stored in
|
|
2974
|
-
the codiac config file in this project, and therefore configuring username and password in this manner is not
|
|
2975
|
-
recommended!
|
|
2976
|
-
|
|
2977
|
-
-v, --verbose
|
|
2978
|
-
Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
2979
|
-
|
|
2980
|
-
--as=as
|
|
2981
|
-
Fires this command with an argument list that was previously remembered using the --rememberAs flag.
|
|
2982
|
-
|
|
2983
|
-
--remember
|
|
2984
|
-
Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
2985
|
-
|
|
2986
|
-
--rememberAs=rememberAs
|
|
2987
|
-
Saves the given argument list so that it can be called by name.
|
|
2988
|
-
|
|
2989
|
-
--unremember=unremember
|
|
2990
|
-
Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were previously stored
|
|
2991
|
-
under the given name (use "--unRemember default" to clear default argument list memorized with the --remember flag).
|
|
2992
|
-
|
|
2993
|
-
--withoutdefaults
|
|
2994
|
-
Prevents any relevant saved defaults from being invoked for this call.
|
|
2995
|
-
```
|
|
2996
|
-
|
|
2997
|
-
_See code: [src/commands/pkg/add.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/pkg/add.ts)_
|
|
2998
|
-
|
|
2999
|
-
## `codiac pkg:list [HELLO]`
|
|
3000
|
-
|
|
3001
|
-
Renders the list of packages that are configured as project exports.
|
|
3002
|
-
|
|
3003
|
-
```
|
|
3004
|
-
USAGE
|
|
3005
|
-
$ codiac pkg:list [HELLO]
|
|
3006
|
-
|
|
3007
|
-
OPTIONS
|
|
3008
|
-
-h, --help Show CLI help.
|
|
3009
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3010
|
-
|
|
3011
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3012
|
-
--rememberAs flag.
|
|
3013
|
-
|
|
3014
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3015
|
-
|
|
3016
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3017
|
-
|
|
3018
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3019
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3020
|
-
list memorized with the --remember flag).
|
|
3021
|
-
|
|
3022
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3023
|
-
```
|
|
3024
|
-
|
|
3025
|
-
_See code: [src/commands/pkg/list.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/pkg/list.ts)_
|
|
3026
|
-
|
|
3027
|
-
## `codiac pkg:patch PACKAGENAME`
|
|
3028
|
-
|
|
3029
|
-
Applies the given values to an existing package export configuration. Both registryUrl and environment act as filters to limit the operation. That is, an upsert of registry targets is performed for the given package, based on the given registryUrl and/or environment.
|
|
3030
|
-
|
|
3031
|
-
```
|
|
3032
|
-
USAGE
|
|
3033
|
-
$ codiac pkg:patch PACKAGENAME
|
|
3034
|
-
|
|
3035
|
-
ARGUMENTS
|
|
3036
|
-
PACKAGENAME package name including, scope prefix. eg: "your-company/your-package"
|
|
3037
|
-
|
|
3038
|
-
OPTIONS
|
|
3039
|
-
-h, --help Show CLI help.
|
|
3040
|
-
|
|
3041
|
-
-s, --set=set Space-delimited list of key-value pairs tp apply with json-path on the left and the desired
|
|
3042
|
-
value on the right. (eg: --set .targets.default.registryUrl=mystuff.azurecr.io)
|
|
3043
|
-
|
|
3044
|
-
-u, --unset=unset Space-delimited list of properties to clear, in json-path format. (eg: --unset
|
|
3045
|
-
.targets.default)
|
|
3046
|
-
|
|
3047
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3048
|
-
|
|
3049
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3050
|
-
--rememberAs flag.
|
|
3051
|
-
|
|
3052
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3053
|
-
|
|
3054
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3055
|
-
|
|
3056
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3057
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3058
|
-
list memorized with the --remember flag).
|
|
3059
|
-
|
|
3060
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3061
|
-
```
|
|
3062
|
-
|
|
3063
|
-
_See code: [src/commands/pkg/patch.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/pkg/patch.ts)_
|
|
3064
|
-
|
|
3065
|
-
## `codiac pkg:remove [PACKAGENAME]`
|
|
3066
|
-
|
|
3067
|
-
Deletes the given package export from the configuration.
|
|
3068
|
-
|
|
3069
|
-
```
|
|
3070
|
-
USAGE
|
|
3071
|
-
$ codiac pkg:remove [PACKAGENAME]
|
|
3072
|
-
|
|
3073
|
-
ARGUMENTS
|
|
3074
|
-
PACKAGENAME package name including, scope prefix. eg: "your-company/your-package"
|
|
3075
|
-
|
|
3076
|
-
OPTIONS
|
|
3077
|
-
-h, --help Show CLI help.
|
|
3078
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3079
|
-
|
|
3080
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3081
|
-
--rememberAs flag.
|
|
3082
|
-
|
|
3083
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3084
|
-
|
|
3085
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3086
|
-
|
|
3087
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3088
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3089
|
-
list memorized with the --remember flag).
|
|
3090
|
-
|
|
3091
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3092
|
-
|
|
3093
|
-
ALIASES
|
|
3094
|
-
$ codiac pkg:delete
|
|
3095
|
-
```
|
|
3096
|
-
|
|
3097
|
-
_See code: [src/commands/pkg/remove.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/pkg/remove.ts)_
|
|
3098
|
-
|
|
3099
|
-
## `codiac portal`
|
|
3100
|
-
|
|
3101
|
-
Starts the codiac relay services, maintains container instance, and opens the web app.
|
|
3102
|
-
|
|
3103
|
-
```
|
|
3104
|
-
USAGE
|
|
3105
|
-
$ codiac portal
|
|
3106
|
-
|
|
3107
|
-
OPTIONS
|
|
3108
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3109
|
-
|
|
3110
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3111
|
-
--rememberAs flag.
|
|
3112
|
-
|
|
3113
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3114
|
-
|
|
3115
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3116
|
-
|
|
3117
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3118
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3119
|
-
list memorized with the --remember flag).
|
|
3120
|
-
|
|
3121
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3122
|
-
```
|
|
3123
|
-
|
|
3124
|
-
_See code: [src/commands/portal.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/portal.ts)_
|
|
3125
|
-
|
|
3126
|
-
## `codiac publish [NAME]`
|
|
3127
|
-
|
|
3128
|
-
Publishes the exports (packages and images) declared in the ProjectConfig.
|
|
3129
|
-
|
|
3130
|
-
```
|
|
3131
|
-
USAGE
|
|
3132
|
-
$ codiac publish [NAME]
|
|
3133
|
-
|
|
3134
|
-
ARGUMENTS
|
|
3135
|
-
NAME The official unique name of a currently sourced dependency. Applies the command to ONLY this sourced
|
|
3136
|
-
dependency.
|
|
3137
|
-
|
|
3138
|
-
OPTIONS
|
|
3139
|
-
-h, --help Show CLI help.
|
|
3140
|
-
|
|
3141
|
-
-i, --image=image (optional, defaults to all) Limits the list of images to publish. Value must match the name
|
|
3142
|
-
property of an image export defined in the codiac project file (codiac.json)
|
|
3143
|
-
|
|
3144
|
-
-i, --includeDeps Also performs the operation on any currently source dependencies.
|
|
3145
|
-
|
|
3146
|
-
-l, --local Publishes to the local built-in image registry. NOTE: this setting gets remembered and is
|
|
3147
|
-
used for subsequent calls unless otherwise specified.
|
|
3148
|
-
|
|
3149
|
-
-o, --only Applies the command only the sourced dependencies selected from a prompt. Quits if no
|
|
3150
|
-
dependencies are currently sourced.
|
|
3151
|
-
|
|
3152
|
-
-p, --password=password (optional, prompts as needed) Password or token at the target registry.
|
|
3153
|
-
|
|
3154
|
-
-r, --remote Publishes to the remote image registry. NOTE: this setting gets remembered and is used for
|
|
3155
|
-
subsequent calls unless otherwise specified.
|
|
3156
|
-
|
|
3157
|
-
-u, --username=username (optional, prompts as needed) Username at the target registry.
|
|
3158
|
-
|
|
3159
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3160
|
-
|
|
3161
|
-
-y, --silent Suppresses user dialogue.
|
|
3162
|
-
|
|
3163
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3164
|
-
--rememberAs flag.
|
|
3165
|
-
|
|
3166
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3167
|
-
|
|
3168
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3169
|
-
|
|
3170
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3171
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3172
|
-
list memorized with the --remember flag).
|
|
3173
|
-
|
|
3174
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3175
|
-
```
|
|
3176
|
-
|
|
3177
|
-
_See code: [src/commands/publish.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/publish.ts)_
|
|
3178
|
-
|
|
3179
|
-
## `codiac pull [NAME]`
|
|
3180
|
-
|
|
3181
|
-
Pulls all commits from upstream to local.
|
|
3182
|
-
|
|
3183
|
-
```
|
|
3184
|
-
USAGE
|
|
3185
|
-
$ codiac pull [NAME]
|
|
3186
|
-
|
|
3187
|
-
ARGUMENTS
|
|
3188
|
-
NAME The official unique name of a currently sourced dependency. Applies the command to ONLY this sourced
|
|
3189
|
-
dependency.
|
|
3190
|
-
|
|
3191
|
-
OPTIONS
|
|
3192
|
-
-h, --help Show CLI help.
|
|
3193
|
-
-i, --includeDeps Also performs the operation on any currently source dependencies.
|
|
3194
|
-
|
|
3195
|
-
-o, --only Applies the command only the sourced dependencies selected from a prompt. Quits if no
|
|
3196
|
-
dependencies are currently sourced.
|
|
3197
|
-
|
|
3198
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3199
|
-
|
|
3200
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3201
|
-
--rememberAs flag.
|
|
3202
|
-
|
|
3203
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3204
|
-
|
|
3205
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3206
|
-
|
|
3207
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3208
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3209
|
-
list memorized with the --remember flag).
|
|
3210
|
-
|
|
3211
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3212
|
-
```
|
|
3213
|
-
|
|
3214
|
-
_See code: [src/commands/pull.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/pull.ts)_
|
|
3215
|
-
|
|
3216
|
-
## `codiac push [NAME]`
|
|
3217
|
-
|
|
3218
|
-
Pushes all local commits upstream.
|
|
3219
|
-
|
|
3220
|
-
```
|
|
3221
|
-
USAGE
|
|
3222
|
-
$ codiac push [NAME]
|
|
3223
|
-
|
|
3224
|
-
ARGUMENTS
|
|
3225
|
-
NAME The official unique name of a currently sourced dependency. Applies the command to ONLY this sourced
|
|
3226
|
-
dependency.
|
|
3227
|
-
|
|
3228
|
-
OPTIONS
|
|
3229
|
-
-h, --help Show CLI help.
|
|
3230
|
-
-i, --includeDeps Also performs the operation on any currently source dependencies.
|
|
3231
|
-
|
|
3232
|
-
-o, --only Applies the command only the sourced dependencies selected from a prompt. Quits if no
|
|
3233
|
-
dependencies are currently sourced.
|
|
3234
|
-
|
|
3235
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3236
|
-
|
|
3237
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3238
|
-
--rememberAs flag.
|
|
3239
|
-
|
|
3240
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3241
|
-
|
|
3242
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3243
|
-
|
|
3244
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3245
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3246
|
-
list memorized with the --remember flag).
|
|
3247
|
-
|
|
3248
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3249
|
-
```
|
|
3250
|
-
|
|
3251
|
-
_See code: [src/commands/push.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/push.ts)_
|
|
3252
|
-
|
|
3253
|
-
## `codiac run`
|
|
3254
|
-
|
|
3255
|
-
Runs the latest build of the api container locally.
|
|
3256
|
-
|
|
3257
|
-
```
|
|
3258
|
-
USAGE
|
|
3259
|
-
$ codiac run
|
|
3260
|
-
|
|
3261
|
-
OPTIONS
|
|
3262
|
-
-b, --build Triggers a new local build beforehand.
|
|
3263
|
-
-d, --detach Run container in background and print the container ID.
|
|
3264
|
-
-e, --entrypoint=entrypoint Overrides the default container startup command.
|
|
3265
|
-
-h, --help Renders the help document for this command.
|
|
3266
|
-
|
|
3267
|
-
-i, --interactive Run the container interactively (in the console; dies with the console). Use
|
|
3268
|
-
-e|--entrypoint to override the startup command for the container.
|
|
3269
|
-
|
|
3270
|
-
-l, --internalPort=internalPort (default: 5775) The port the application inside the container is listening on. Sets
|
|
3271
|
-
the port to which map incoming requests on the container. This port mapping MUST
|
|
3272
|
-
match whatever port number the actual application is listening on.
|
|
3273
|
-
|
|
3274
|
-
-m, --mountFolder=mountFolder Mounts a folder on the host as a read-write volume on the container. In format
|
|
3275
|
-
"src=~/my/local/folder,dst=/root/in/container".
|
|
3276
|
-
|
|
3277
|
-
-n, --network=network The docker network to which the container will be attached (defaults to a network
|
|
3278
|
-
named as the company code, which will be created on demand as a bridge network).
|
|
3279
|
-
|
|
3280
|
-
-p, --port=port (default: 5775) Sets the external port to open on the container. That is, the port
|
|
3281
|
-
on which the api will be listening to calls from outside the container.
|
|
3282
|
-
|
|
3283
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3284
|
-
|
|
3285
|
-
-w, --watch Forces a detach run and follows log output from the container.
|
|
3286
|
-
|
|
3287
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3288
|
-
--rememberAs flag.
|
|
3289
|
-
|
|
3290
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets
|
|
3291
|
-
called.
|
|
3292
|
-
|
|
3293
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3294
|
-
|
|
3295
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments
|
|
3296
|
-
that were previously stored under the given name (use "--unRemember default" to clear
|
|
3297
|
-
default argument list memorized with the --remember flag).
|
|
3298
|
-
|
|
3299
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3300
|
-
```
|
|
3301
|
-
|
|
3302
|
-
_See code: [src/commands/run.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/run.ts)_
|
|
3303
|
-
|
|
3304
|
-
## `codiac secretStore:capture`
|
|
3305
|
-
|
|
3306
|
-
Upserts a reference to an existing secretStore.
|
|
3307
|
-
|
|
3308
|
-
```
|
|
3309
|
-
USAGE
|
|
3310
|
-
$ codiac secretStore:capture
|
|
3311
|
-
|
|
3312
|
-
OPTIONS
|
|
3313
|
-
-h, --help Show CLI help.
|
|
3314
|
-
|
|
3315
|
-
-l, --location=location The region or data center in which the secret store resides (use the code
|
|
3316
|
-
name, eg: in Aws use 'us-east-1', NOT 'Virginia, US').
|
|
3317
|
-
|
|
3318
|
-
-n, --name=name The resource name of the secret store within the cloud provider
|
|
3319
|
-
subscription.
|
|
3320
|
-
|
|
3321
|
-
-p, --provider=(azure|aws|dockerHub|other) The cloud provider hosting the secret store.
|
|
3322
|
-
|
|
3323
|
-
-s, --subscriptionId=subscriptionId The id of the cloud provider account in which the secret store resides (in
|
|
3324
|
-
Aws, this is the 'AccountId').
|
|
3325
|
-
|
|
3326
|
-
-u, --url=url The container registry url.
|
|
3327
|
-
|
|
3328
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the
|
|
3329
|
-
console output.
|
|
3330
|
-
|
|
3331
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that
|
|
3332
|
-
are remembered from prior runs. Requires:
|
|
3333
|
-
registry,storeType,storeName,name
|
|
3334
|
-
|
|
3335
|
-
-z, --toScript Outputs an assembled command string, NO execution
|
|
3336
|
-
|
|
3337
|
-
--as=as Fires this command with an argument list that was previously remembered
|
|
3338
|
-
using the --rememberAs flag.
|
|
3339
|
-
|
|
3340
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command
|
|
3341
|
-
gets called.
|
|
3342
|
-
|
|
3343
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3344
|
-
|
|
3345
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the
|
|
3346
|
-
arguments that were previously stored under the given name (use
|
|
3347
|
-
"--unRemember default" to clear default argument list memorized with the
|
|
3348
|
-
--remember flag).
|
|
3349
|
-
|
|
3350
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3351
|
-
|
|
3352
|
-
ALIASES
|
|
3353
|
-
$ codiac secretStore
|
|
3354
|
-
```
|
|
3355
|
-
|
|
3356
|
-
_See code: [src/commands/secretStore/capture.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/secretStore/capture.ts)_
|
|
3357
|
-
|
|
3358
|
-
## `codiac secretStore:forget`
|
|
3359
|
-
|
|
3360
|
-
Removes the reference to the given container registry for the tenant. Does NOT delete the registry itself.
|
|
3361
|
-
|
|
3362
|
-
```
|
|
3363
|
-
USAGE
|
|
3364
|
-
$ codiac secretStore:forget
|
|
3365
|
-
|
|
3366
|
-
OPTIONS
|
|
3367
|
-
-h, --help Show CLI help.
|
|
3368
|
-
-n, --name=name The name of the secret store to forget.
|
|
3369
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3370
|
-
|
|
3371
|
-
-y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
|
|
3372
|
-
prior runs. Requires: name
|
|
3373
|
-
|
|
3374
|
-
-z, --toScript Outputs an assembled command string, NO execution
|
|
3375
|
-
|
|
3376
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3377
|
-
--rememberAs flag.
|
|
3378
|
-
|
|
3379
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3380
|
-
|
|
3381
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3382
|
-
|
|
3383
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3384
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3385
|
-
list memorized with the --remember flag).
|
|
3386
|
-
|
|
3387
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3388
|
-
```
|
|
3389
|
-
|
|
3390
|
-
_See code: [src/commands/secretStore/forget.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/secretStore/forget.ts)_
|
|
3391
|
-
|
|
3392
|
-
## `codiac stage [FILES]`
|
|
3393
|
-
|
|
3394
|
-
Flags files to be included in the next commit.
|
|
3395
|
-
|
|
3396
|
-
```
|
|
3397
|
-
USAGE
|
|
3398
|
-
$ codiac stage [FILES]
|
|
3399
|
-
|
|
3400
|
-
ARGUMENTS
|
|
3401
|
-
FILES Space-separated list of files to stage. Paths are relative to the main project root.
|
|
3402
|
-
|
|
3403
|
-
OPTIONS
|
|
3404
|
-
-A, --all Include all modified files.
|
|
3405
|
-
-c, --commit=message Commit the staged changes using the given message
|
|
3406
|
-
-h, --help Show CLI help.
|
|
3407
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3408
|
-
|
|
3409
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3410
|
-
--rememberAs flag.
|
|
3411
|
-
|
|
3412
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3413
|
-
|
|
3414
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3415
|
-
|
|
3416
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3417
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3418
|
-
list memorized with the --remember flag).
|
|
3419
|
-
|
|
3420
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3421
|
-
```
|
|
3422
|
-
|
|
3423
|
-
_See code: [src/commands/stage.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/stage.ts)_
|
|
3424
|
-
|
|
3425
|
-
## `codiac stash [FILE]`
|
|
3426
|
-
|
|
3427
|
-
describe the command here
|
|
3428
|
-
|
|
3429
|
-
```
|
|
3430
|
-
USAGE
|
|
3431
|
-
$ codiac stash [FILE]
|
|
3432
|
-
|
|
3433
|
-
OPTIONS
|
|
3434
|
-
-f, --force
|
|
3435
|
-
-h, --help Show CLI help.
|
|
3436
|
-
-n, --name=name name to print
|
|
3437
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3438
|
-
|
|
3439
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3440
|
-
--rememberAs flag.
|
|
3441
|
-
|
|
3442
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3443
|
-
|
|
3444
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3445
|
-
|
|
3446
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3447
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3448
|
-
list memorized with the --remember flag).
|
|
3449
|
-
|
|
3450
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3451
|
-
```
|
|
3452
|
-
|
|
3453
|
-
_See code: [src/commands/stash.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/stash.ts)_
|
|
3454
|
-
|
|
3455
|
-
## `codiac status`
|
|
3456
|
-
|
|
3457
|
-
Shows the current uncommitted changes in the current branch.
|
|
3458
|
-
|
|
3459
|
-
```
|
|
3460
|
-
USAGE
|
|
3461
|
-
$ codiac status
|
|
3462
|
-
|
|
3463
|
-
OPTIONS
|
|
3464
|
-
-h, --help Show CLI help.
|
|
3465
|
-
-s, --staged Include the list of staged changes.
|
|
3466
|
-
-u, --unstaged Include the list of unstaged changes.
|
|
3467
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3468
|
-
|
|
3469
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3470
|
-
--rememberAs flag.
|
|
3471
|
-
|
|
3472
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3473
|
-
|
|
3474
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3475
|
-
|
|
3476
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3477
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3478
|
-
list memorized with the --remember flag).
|
|
3479
|
-
|
|
3480
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3481
|
-
```
|
|
3482
|
-
|
|
3483
|
-
_See code: [src/commands/status.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/status.ts)_
|
|
3484
|
-
|
|
3485
|
-
## `codiac stop`
|
|
3486
|
-
|
|
3487
|
-
Stops the running container for this project
|
|
3488
|
-
|
|
3489
|
-
```
|
|
3490
|
-
USAGE
|
|
3491
|
-
$ codiac stop
|
|
3492
|
-
|
|
3493
|
-
OPTIONS
|
|
3494
|
-
-h, --help Show CLI help.
|
|
3495
|
-
-r, --remove Deletes the container after stopping it
|
|
3496
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3497
|
-
|
|
3498
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3499
|
-
--rememberAs flag.
|
|
3500
|
-
|
|
3501
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3502
|
-
|
|
3503
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3504
|
-
|
|
3505
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3506
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3507
|
-
list memorized with the --remember flag).
|
|
3508
|
-
|
|
3509
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3510
|
-
```
|
|
3511
|
-
|
|
3512
|
-
_See code: [src/commands/stop.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/stop.ts)_
|
|
3513
|
-
|
|
3514
|
-
## `codiac switch [NAME]`
|
|
3515
|
-
|
|
3516
|
-
Changes branch on the main project and any sourced dependencies.
|
|
3517
|
-
|
|
3518
|
-
```
|
|
3519
|
-
USAGE
|
|
3520
|
-
$ codiac switch [NAME]
|
|
3521
|
-
|
|
3522
|
-
ARGUMENTS
|
|
3523
|
-
NAME The name of the branch to switch to (Optional: will prompt the user when missing).
|
|
3524
|
-
|
|
3525
|
-
OPTIONS
|
|
3526
|
-
-h, --help Show CLI help.
|
|
3527
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3528
|
-
|
|
3529
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3530
|
-
--rememberAs flag.
|
|
3531
|
-
|
|
3532
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3533
|
-
|
|
3534
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3535
|
-
|
|
3536
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3537
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3538
|
-
list memorized with the --remember flag).
|
|
3539
|
-
|
|
3540
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3541
|
-
```
|
|
3542
|
-
|
|
3543
|
-
_See code: [src/commands/switch.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/switch.ts)_
|
|
3544
|
-
|
|
3545
|
-
## `codiac sync [NAME]`
|
|
3546
|
-
|
|
3547
|
-
Merges the given branch into the current branch.
|
|
3548
|
-
|
|
3549
|
-
```
|
|
3550
|
-
USAGE
|
|
3551
|
-
$ codiac sync [NAME]
|
|
3552
|
-
|
|
3553
|
-
ARGUMENTS
|
|
3554
|
-
NAME The official unique name of a currently sourced dependency. Applies the command to ONLY this sourced
|
|
3555
|
-
dependency.
|
|
3556
|
-
|
|
3557
|
-
OPTIONS
|
|
3558
|
-
-b, --with=with (required) Branch to merge into this one
|
|
3559
|
-
-h, --help Show CLI help.
|
|
3560
|
-
-i, --includeDeps Also performs the operation on any currently source dependencies.
|
|
3561
|
-
|
|
3562
|
-
-o, --only Applies the command only the sourced dependencies selected from a prompt. Quits if no
|
|
3563
|
-
dependencies are currently sourced.
|
|
3564
|
-
|
|
3565
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3566
|
-
|
|
3567
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3568
|
-
--rememberAs flag.
|
|
3569
|
-
|
|
3570
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3571
|
-
|
|
3572
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3573
|
-
|
|
3574
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3575
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3576
|
-
list memorized with the --remember flag).
|
|
3577
|
-
|
|
3578
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3579
|
-
```
|
|
3580
|
-
|
|
3581
|
-
_See code: [src/commands/sync.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/sync.ts)_
|
|
3582
|
-
|
|
3583
|
-
## `codiac tenant:create [NAME]`
|
|
3584
|
-
|
|
3585
|
-
Registers a new tenant with the current user as the administrator.
|
|
3586
|
-
|
|
3587
|
-
```
|
|
3588
|
-
USAGE
|
|
3589
|
-
$ codiac tenant:create [NAME]
|
|
3590
|
-
|
|
3591
|
-
ARGUMENTS
|
|
3592
|
-
NAME The name of the environment to create
|
|
3593
|
-
|
|
3594
|
-
OPTIONS
|
|
3595
|
-
-c, --code=code (Optional, not recommended) Proposed human readable unique identifier code for the tenant
|
|
3596
|
-
origanization. This command will fail if the given tenant code is already taken.
|
|
3597
|
-
|
|
3598
|
-
-h, --help Show CLI help.
|
|
3599
|
-
|
|
3600
|
-
-n, --name=name Full name of the tenant organization.
|
|
3601
|
-
|
|
3602
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3603
|
-
|
|
3604
|
-
-y, --silent Suppresses user interaction.
|
|
3605
|
-
|
|
3606
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3607
|
-
--rememberAs flag.
|
|
3608
|
-
|
|
3609
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3610
|
-
|
|
3611
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3612
|
-
|
|
3613
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3614
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3615
|
-
list memorized with the --remember flag).
|
|
3616
|
-
|
|
3617
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3618
|
-
```
|
|
3619
|
-
|
|
3620
|
-
_See code: [src/commands/tenant/create.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/tenant/create.ts)_
|
|
3621
|
-
|
|
3622
|
-
## `codiac tenant:switch [NAME]`
|
|
3623
|
-
|
|
3624
|
-
Sets a different tenant context from the current user's list of tenants.
|
|
3625
|
-
|
|
3626
|
-
```
|
|
3627
|
-
USAGE
|
|
3628
|
-
$ codiac tenant:switch [NAME]
|
|
3629
|
-
|
|
3630
|
-
ARGUMENTS
|
|
3631
|
-
NAME The name of the environment to create
|
|
3632
|
-
|
|
3633
|
-
OPTIONS
|
|
3634
|
-
-h, --help Show CLI help.
|
|
3635
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3636
|
-
|
|
3637
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3638
|
-
--rememberAs flag.
|
|
3639
|
-
|
|
3640
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3641
|
-
|
|
3642
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3643
|
-
|
|
3644
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3645
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3646
|
-
list memorized with the --remember flag).
|
|
3647
|
-
|
|
3648
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3649
|
-
```
|
|
3650
|
-
|
|
3651
|
-
_See code: [src/commands/tenant/switch.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/tenant/switch.ts)_
|
|
3652
|
-
|
|
3653
|
-
## `codiac unstage [FILES]`
|
|
3654
|
-
|
|
3655
|
-
Flags files to be included in the next commit.
|
|
3656
|
-
|
|
3657
|
-
```
|
|
3658
|
-
USAGE
|
|
3659
|
-
$ codiac unstage [FILES]
|
|
3660
|
-
|
|
3661
|
-
ARGUMENTS
|
|
3662
|
-
FILES Space-separated list of files to stage. Paths are relative to the main project root.
|
|
3663
|
-
|
|
3664
|
-
OPTIONS
|
|
3665
|
-
-A, --all Include all modified files.
|
|
3666
|
-
-h, --help Show CLI help.
|
|
3667
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3668
|
-
|
|
3669
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3670
|
-
--rememberAs flag.
|
|
3671
|
-
|
|
3672
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3673
|
-
|
|
3674
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3675
|
-
|
|
3676
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3677
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3678
|
-
list memorized with the --remember flag).
|
|
3679
|
-
|
|
3680
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3681
|
-
```
|
|
3682
|
-
|
|
3683
|
-
_See code: [src/commands/unstage.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/unstage.ts)_
|
|
3684
|
-
|
|
3685
|
-
## `codiac update [CHANNEL]`
|
|
3686
|
-
|
|
3687
|
-
update the codiac CLI
|
|
3688
|
-
|
|
3689
|
-
```
|
|
3690
|
-
USAGE
|
|
3691
|
-
$ codiac update [CHANNEL]
|
|
3692
|
-
|
|
3693
|
-
OPTIONS
|
|
3694
|
-
-a, --available Install a specific version.
|
|
3695
|
-
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
|
|
3696
|
-
-v, --version=version Install a specific version.
|
|
3697
|
-
--force Force a re-download of the requested version.
|
|
3698
|
-
|
|
3699
|
-
EXAMPLES
|
|
3700
|
-
[object Object]
|
|
3701
|
-
[object Object]
|
|
3702
|
-
[object Object]
|
|
3703
|
-
[object Object]
|
|
3704
|
-
```
|
|
3705
|
-
|
|
3706
|
-
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v3.0.7/src/commands/update.ts)_
|
|
3707
|
-
|
|
3708
|
-
## `codiac version`
|
|
3709
|
-
|
|
3710
|
-
```
|
|
3711
|
-
USAGE
|
|
3712
|
-
$ codiac version
|
|
3713
|
-
|
|
3714
|
-
OPTIONS
|
|
3715
|
-
--json Format output as json.
|
|
3716
|
-
|
|
3717
|
-
--verbose Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI
|
|
3718
|
-
is using.
|
|
3719
|
-
```
|
|
3720
|
-
|
|
3721
|
-
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.1.3/src/commands/version.ts)_
|
|
3722
|
-
|
|
3723
|
-
## `codiac whereami [FILE]`
|
|
3724
|
-
|
|
3725
|
-
Renders the current cabinet context the image project is pointed to. ie: Tenant, Enterprise, Environment, Cabinet.
|
|
3726
|
-
|
|
3727
|
-
```
|
|
3728
|
-
USAGE
|
|
3729
|
-
$ codiac whereami [FILE]
|
|
3730
|
-
|
|
3731
|
-
OPTIONS
|
|
3732
|
-
-f, --force
|
|
3733
|
-
-h, --help Show CLI help.
|
|
3734
|
-
-n, --name=name name to print
|
|
3735
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3736
|
-
|
|
3737
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3738
|
-
--rememberAs flag.
|
|
3739
|
-
|
|
3740
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3741
|
-
|
|
3742
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3743
|
-
|
|
3744
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
|
|
3745
|
-
previously stored under the given name (use "--unRemember default" to clear default argument
|
|
3746
|
-
list memorized with the --remember flag).
|
|
3747
|
-
|
|
3748
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3749
|
-
```
|
|
3750
|
-
|
|
3751
|
-
_See code: [src/commands/whereami.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/whereami.ts)_
|
|
3752
|
-
|
|
3753
|
-
## `codiac whoami`
|
|
3754
|
-
|
|
3755
|
-
Renders the codiac username and its current tenant.
|
|
3756
|
-
|
|
3757
|
-
```
|
|
3758
|
-
USAGE
|
|
3759
|
-
$ codiac whoami
|
|
3760
|
-
|
|
3761
|
-
OPTIONS
|
|
3762
|
-
-h, --help Show CLI help.
|
|
3763
|
-
-o, --output=(text|json) [default: text] Format for the response data.
|
|
3764
|
-
-v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
|
|
3765
|
-
|
|
3766
|
-
--as=as Fires this command with an argument list that was previously remembered using the
|
|
3767
|
-
--rememberAs flag.
|
|
3768
|
-
|
|
3769
|
-
--remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
|
|
3770
|
-
|
|
3771
|
-
--rememberAs=rememberAs Saves the given argument list so that it can be called by name.
|
|
3772
|
-
|
|
3773
|
-
--unremember=unremember Administrative only: DOES NOT fire the actual command. Simply clears the arguments that
|
|
3774
|
-
were previously stored under the given name (use "--unRemember default" to clear default
|
|
3775
|
-
argument list memorized with the --remember flag).
|
|
3776
|
-
|
|
3777
|
-
--withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
|
|
3778
|
-
|
|
3779
|
-
ALIASES
|
|
3780
|
-
$ codiac user:show
|
|
3781
|
-
```
|
|
3782
|
-
|
|
3783
|
-
_See code: [src/commands/whoami.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/whoami.ts)_
|
|
3784
|
-
|
|
3785
37
|
<!-- commandsstop -->
|