@codiac.io/codiac-cli 1.2.129 → 1.2.134

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