@codiac.io/codiac-cli 1.2.167 → 1.2.169

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 (522) hide show
  1. package/README.md +3326 -45
  2. package/bin/dev +16 -16
  3. package/bin/dev.cmd +2 -2
  4. package/bin/run +3 -3
  5. package/bin/run.cmd +3 -3
  6. package/codiac.json +9 -9
  7. package/lib/api-command-base.d.ts +0 -0
  8. package/lib/api-command-base.js +52 -0
  9. package/lib/api-command-base.js.map +1 -0
  10. package/lib/apis/codiac-api/common/api-client-base.d.ts +165 -165
  11. package/lib/apis/codiac-api/common/api-client-base.js +547 -547
  12. package/lib/apis/codiac-api/common/api-user-creds.d.ts +7 -7
  13. package/lib/apis/codiac-api/common/api-user-creds.js +18 -18
  14. package/lib/apis/codiac-api/common/config-loader.d.ts +6 -6
  15. package/lib/apis/codiac-api/common/config-loader.js +18 -18
  16. package/lib/apis/codiac-api/common/endpoint-spec.d.ts +17 -17
  17. package/lib/apis/codiac-api/common/endpoint-spec.js +27 -27
  18. package/lib/apis/codiac-api/common/security/api-auth-methods-legacy.d.ts +87 -87
  19. package/lib/apis/codiac-api/common/security/api-auth-methods-legacy.js +367 -367
  20. package/lib/apis/codiac-api/common/security/auth-constants.d.ts +15 -15
  21. package/lib/apis/codiac-api/common/security/auth-constants.js +21 -21
  22. package/lib/apis/codiac-api/common/security/i-auth-client.d.ts +44 -44
  23. package/lib/apis/codiac-api/common/security/i-auth-client.js +2 -2
  24. package/lib/apis/codiac-api/common/security/token-holder.d.ts +13 -13
  25. package/lib/apis/codiac-api/common/security/token-holder.js +17 -17
  26. package/lib/apis/codiac-api/common/utils.d.ts +23 -23
  27. package/lib/apis/codiac-api/common/utils.js +82 -82
  28. package/lib/apis/codiac-api/contracts/index.d.ts +1 -1
  29. package/lib/apis/codiac-api/contracts/index.js +4 -4
  30. package/lib/apis/codiac-api/gen/client-config.d.ts +10 -10
  31. package/lib/apis/codiac-api/gen/client-config.js +28 -28
  32. package/lib/apis/codiac-api/gen/client.d.ts +1663 -1663
  33. package/lib/apis/codiac-api/gen/client.js +15629 -15629
  34. package/lib/apis/codiac-api/gen/contracts.d.ts +2722 -2722
  35. package/lib/apis/codiac-api/gen/contracts.js +402 -402
  36. package/lib/apis/codiac-api/index.d.ts +3 -3
  37. package/lib/apis/codiac-api/index.js +8 -8
  38. package/lib/apis/codiac-relay/common/api-client-base.d.ts +165 -165
  39. package/lib/apis/codiac-relay/common/api-client-base.js +547 -547
  40. package/lib/apis/codiac-relay/common/api-user-creds.d.ts +7 -7
  41. package/lib/apis/codiac-relay/common/api-user-creds.js +18 -18
  42. package/lib/apis/codiac-relay/common/config-loader.d.ts +6 -6
  43. package/lib/apis/codiac-relay/common/config-loader.js +18 -18
  44. package/lib/apis/codiac-relay/common/endpoint-spec.d.ts +17 -17
  45. package/lib/apis/codiac-relay/common/endpoint-spec.js +27 -27
  46. package/lib/apis/codiac-relay/common/security/api-auth-methods-legacy.d.ts +87 -87
  47. package/lib/apis/codiac-relay/common/security/api-auth-methods-legacy.js +367 -367
  48. package/lib/apis/codiac-relay/common/security/auth-constants.d.ts +15 -15
  49. package/lib/apis/codiac-relay/common/security/auth-constants.js +21 -21
  50. package/lib/apis/codiac-relay/common/security/i-auth-client.d.ts +44 -44
  51. package/lib/apis/codiac-relay/common/security/i-auth-client.js +2 -2
  52. package/lib/apis/codiac-relay/common/security/token-holder.d.ts +13 -13
  53. package/lib/apis/codiac-relay/common/security/token-holder.js +17 -17
  54. package/lib/apis/codiac-relay/common/utils.d.ts +23 -23
  55. package/lib/apis/codiac-relay/common/utils.js +82 -82
  56. package/lib/apis/codiac-relay/contracts/index.d.ts +1 -1
  57. package/lib/apis/codiac-relay/contracts/index.js +4 -4
  58. package/lib/apis/codiac-relay/gen/client-config.d.ts +10 -10
  59. package/lib/apis/codiac-relay/gen/client-config.js +28 -28
  60. package/lib/apis/codiac-relay/gen/client.d.ts +244 -244
  61. package/lib/apis/codiac-relay/gen/client.js +1862 -1862
  62. package/lib/apis/codiac-relay/gen/contracts.d.ts +3111 -3111
  63. package/lib/apis/codiac-relay/gen/contracts.js +434 -434
  64. package/lib/apis/codiac-relay/index.d.ts +3 -3
  65. package/lib/apis/codiac-relay/index.js +8 -8
  66. package/lib/azure-rest-client.d.ts +6 -0
  67. package/lib/azure-rest-client.js +36 -0
  68. package/lib/azure-rest-client.js.map +1 -0
  69. package/lib/cli-common/ImagesList.js +66 -66
  70. package/lib/cli-common/argument-manager.d.ts +28 -28
  71. package/lib/cli-common/argument-manager.js +194 -194
  72. package/lib/cli-common/built-in-cli-user-input.d.ts +18 -18
  73. package/lib/cli-common/built-in-cli-user-input.js +309 -309
  74. package/lib/cli-common/cli-interfaces.js +6 -6
  75. package/lib/cli-common/command-base.d.ts +72 -72
  76. package/lib/cli-common/command-base.js +181 -181
  77. package/lib/cli-common/entities/index.d.ts +1 -1
  78. package/lib/cli-common/entities/index.js +4 -4
  79. package/lib/cli-common/entities/prompt-choice.d.ts +7 -7
  80. package/lib/cli-common/entities/prompt-choice.js +2 -2
  81. package/lib/cli-common/file-selector.d.ts +48 -48
  82. package/lib/cli-common/file-selector.js +186 -186
  83. package/lib/cli-common/i-user-input-provider.js +18 -18
  84. package/lib/cli-common/index.d.ts +4 -4
  85. package/lib/cli-common/index.js +10 -10
  86. package/lib/cli-common/mock-ui.d.ts +27 -27
  87. package/lib/cli-common/mock-ui.js +82 -82
  88. package/lib/cli-common/prompt-select-fuzzy.d.ts +19 -19
  89. package/lib/cli-common/prompt-select-fuzzy.js +118 -118
  90. package/lib/cli-common/tenant-contextualizer.js +435 -435
  91. package/lib/cli-common/test/tenant-contextualizer.spec.js +142 -142
  92. package/lib/cli-entities/output-format-enum.d.ts +7 -7
  93. package/lib/cli-entities/output-format-enum.js +11 -11
  94. package/lib/cli-entities/prompt-choice.js +5 -5
  95. package/lib/codiac-constants.d.ts +35 -35
  96. package/lib/codiac-constants.js +40 -40
  97. package/lib/codiac-entities/asset-binding.d.ts +12 -12
  98. package/lib/codiac-entities/asset-binding.js +17 -17
  99. package/lib/codiac-entities/azure-container-registry.d.ts +4 -4
  100. package/lib/codiac-entities/azure-container-registry.js +2 -2
  101. package/lib/codiac-entities/azure-service-principal.d.ts +23 -23
  102. package/lib/codiac-entities/azure-service-principal.js +23 -23
  103. package/lib/codiac-entities/cloud-account-ref.d.ts +28 -28
  104. package/lib/codiac-entities/cloud-account-ref.js +36 -36
  105. package/lib/codiac-entities/deployment-temp.js +132 -132
  106. package/lib/codiac-entities/i-cloud-account-ref.d.ts +5 -5
  107. package/lib/codiac-entities/i-cloud-account-ref.js +2 -2
  108. package/lib/command-base-enterprise.d.ts +121 -121
  109. package/lib/command-base-enterprise.js +523 -523
  110. package/lib/command-base-tenantless.d.ts +44 -44
  111. package/lib/command-base-tenantless.js +172 -172
  112. package/lib/commands/asset/create.d.ts +42 -42
  113. package/lib/commands/asset/create.js +466 -466
  114. package/lib/commands/asset/destroy.d.ts +20 -20
  115. package/lib/commands/asset/destroy.js +128 -128
  116. package/lib/commands/asset/helm.d.ts +23 -23
  117. package/lib/commands/asset/helm.js +152 -152
  118. package/lib/commands/asset/list.d.ts +28 -28
  119. package/lib/commands/asset/list.js +171 -171
  120. package/lib/commands/asset/probe/create.d.ts +38 -38
  121. package/lib/commands/asset/probe/create.js +186 -186
  122. package/lib/commands/asset/recycle.d.ts +23 -23
  123. package/lib/commands/asset/recycle.js +174 -174
  124. package/lib/commands/asset/view.d.ts +188 -188
  125. package/lib/commands/asset/view.js +1364 -1364
  126. package/lib/commands/asset/volume/create.d.ts +23 -23
  127. package/lib/commands/asset/volume/create.js +175 -175
  128. package/lib/commands/asset/volume/delete.d.ts +19 -19
  129. package/lib/commands/asset/volume/delete.js +111 -111
  130. package/lib/commands/asset/volume/list.d.ts +19 -19
  131. package/lib/commands/asset/volume/list.js +69 -69
  132. package/lib/commands/branch/current.d.ts +10 -10
  133. package/lib/commands/branch/current.js +33 -33
  134. package/lib/commands/branch/list.d.ts +15 -15
  135. package/lib/commands/branch/list.js +55 -55
  136. package/lib/commands/branch.d.ts +12 -12
  137. package/lib/commands/branch.js +41 -41
  138. package/lib/commands/build.d.ts +37 -37
  139. package/lib/commands/build.js +118 -118
  140. package/lib/commands/cabinet/create.d.ts +21 -21
  141. package/lib/commands/cabinet/create.js +107 -107
  142. package/lib/commands/cabinet/list.d.ts +23 -23
  143. package/lib/commands/cabinet/list.js +133 -133
  144. package/lib/commands/cabinet/obliterate.d.ts +20 -20
  145. package/lib/commands/cabinet/obliterate.js +82 -82
  146. package/lib/commands/cli.d.ts +10 -10
  147. package/lib/commands/cli.js +99 -99
  148. package/lib/commands/commit.d.ts +11 -11
  149. package/lib/commands/commit.js +39 -39
  150. package/lib/commands/config/add.d.ts +78 -78
  151. package/lib/commands/config/add.js +559 -559
  152. package/lib/commands/config/delete.d.ts +18 -18
  153. package/lib/commands/config/delete.js +118 -118
  154. package/lib/commands/config/deploy.d.ts +22 -22
  155. package/lib/commands/config/deploy.js +124 -124
  156. package/lib/commands/config/import.d.ts +27 -27
  157. package/lib/commands/config/import.js +195 -195
  158. package/lib/commands/config/view.d.ts +25 -25
  159. package/lib/commands/config/view.js +120 -120
  160. package/lib/commands/csp/login.d.ts +18 -18
  161. package/lib/commands/csp/login.js +108 -108
  162. package/lib/commands/csp/logout.d.ts +15 -15
  163. package/lib/commands/csp/logout.js +73 -73
  164. package/lib/commands/dep/create.d.ts +13 -13
  165. package/lib/commands/dep/create.js +40 -40
  166. package/lib/commands/dep/install.d.ts +9 -9
  167. package/lib/commands/dep/install.js +29 -29
  168. package/lib/commands/dep/list.d.ts +55 -55
  169. package/lib/commands/dep/list.js +97 -97
  170. package/lib/commands/dep/remove.d.ts +12 -12
  171. package/lib/commands/dep/remove.js +61 -61
  172. package/lib/commands/dep/source.d.ts +13 -13
  173. package/lib/commands/dep/source.js +82 -82
  174. package/lib/commands/dep/syncup.d.ts +11 -11
  175. package/lib/commands/dep/syncup.js +53 -53
  176. package/lib/commands/dep/unsource.d.ts +14 -14
  177. package/lib/commands/dep/unsource.js +67 -67
  178. package/lib/commands/dep/upgrade.d.ts +44 -44
  179. package/lib/commands/dep/upgrade.js +243 -243
  180. package/lib/commands/dep.d.ts +12 -12
  181. package/lib/commands/dep.js +50 -50
  182. package/lib/commands/deploy.d.ts +38 -38
  183. package/lib/commands/deploy.js +382 -382
  184. package/lib/commands/enterprise/create.d.ts +20 -20
  185. package/lib/commands/enterprise/create.js +97 -97
  186. package/lib/commands/enterprise/list.d.ts +14 -14
  187. package/lib/commands/enterprise/list.js +83 -83
  188. package/lib/commands/env/add.d.ts +22 -22
  189. package/lib/commands/env/add.js +199 -199
  190. package/lib/commands/environment/create.d.ts +19 -19
  191. package/lib/commands/environment/create.js +88 -88
  192. package/lib/commands/environment/list.d.ts +25 -25
  193. package/lib/commands/environment/list.js +157 -157
  194. package/lib/commands/filestore/capture.d.ts +31 -31
  195. package/lib/commands/filestore/capture.js +341 -341
  196. package/lib/commands/host/map.d.ts +33 -33
  197. package/lib/commands/host/map.js +346 -346
  198. package/lib/commands/identity/delete.d.ts +15 -15
  199. package/lib/commands/identity/delete.js +82 -82
  200. package/lib/commands/identity/list.d.ts +11 -11
  201. package/lib/commands/identity/list.js +42 -42
  202. package/lib/commands/identity.d.ts +22 -22
  203. package/lib/commands/identity.js +76 -76
  204. package/lib/commands/imageRegistry/capture.d.ts +27 -27
  205. package/lib/commands/imageRegistry/capture.js +159 -159
  206. package/lib/commands/imageRegistry/forget.d.ts +23 -23
  207. package/lib/commands/imageRegistry/forget.js +160 -160
  208. package/lib/commands/imageRegistry/pullSecret/set.d.ts +27 -27
  209. package/lib/commands/imageRegistry/pullSecret/set.js +299 -299
  210. package/lib/commands/imageRegistry/pullSecret/unset.d.ts +24 -24
  211. package/lib/commands/imageRegistry/pullSecret/unset.js +242 -242
  212. package/lib/commands/images/add.d.ts +25 -25
  213. package/lib/commands/images/add.js +75 -75
  214. package/lib/commands/images/list.d.ts +14 -14
  215. package/lib/commands/images/list.js +71 -71
  216. package/lib/commands/images/patch.d.ts +14 -14
  217. package/lib/commands/images/patch.js +92 -92
  218. package/lib/commands/images/remove.d.ts +12 -12
  219. package/lib/commands/images/remove.js +37 -37
  220. package/lib/commands/images/version.d.ts +16 -16
  221. package/lib/commands/images/version.js +64 -64
  222. package/lib/commands/init.d.ts +17 -17
  223. package/lib/commands/init.js +130 -130
  224. package/lib/commands/kit/create.d.ts +25 -25
  225. package/lib/commands/kit/create.js +141 -141
  226. package/lib/commands/login.d.ts +22 -22
  227. package/lib/commands/login.js +92 -92
  228. package/lib/commands/logout.d.ts +8 -8
  229. package/lib/commands/logout.js +36 -36
  230. package/lib/commands/merge.d.ts +12 -12
  231. package/lib/commands/merge.js +42 -42
  232. package/lib/commands/noc/cluster/create.d.ts +28 -28
  233. package/lib/commands/noc/cluster/create.js +132 -132
  234. package/lib/commands/noc/cluster/deinit.d.ts +17 -17
  235. package/lib/commands/noc/cluster/deinit.js +116 -116
  236. package/lib/commands/noc/cluster/destroy.d.ts +20 -20
  237. package/lib/commands/noc/cluster/destroy.js +137 -137
  238. package/lib/commands/noc/cluster/forget.d.ts +16 -16
  239. package/lib/commands/noc/cluster/forget.js +136 -136
  240. package/lib/commands/noc/cluster/grant.d.ts +24 -24
  241. package/lib/commands/noc/cluster/grant.js +159 -159
  242. package/lib/commands/noc/cluster/init.d.ts +17 -17
  243. package/lib/commands/noc/cluster/init.js +116 -116
  244. package/lib/commands/noc/cluster/list.d.ts +21 -21
  245. package/lib/commands/noc/cluster/list.js +83 -83
  246. package/lib/commands/noc/cluster/recreate.d.ts +28 -28
  247. package/lib/commands/noc/cluster/recreate.js +185 -185
  248. package/lib/commands/pkg/add.d.ts +15 -15
  249. package/lib/commands/pkg/add.js +42 -42
  250. package/lib/commands/pkg/list.d.ts +9 -9
  251. package/lib/commands/pkg/list.js +32 -32
  252. package/lib/commands/pkg/patch.d.ts +13 -13
  253. package/lib/commands/pkg/patch.js +78 -78
  254. package/lib/commands/pkg/remove.d.ts +12 -12
  255. package/lib/commands/pkg/remove.js +69 -69
  256. package/lib/commands/portal.d.ts +11 -11
  257. package/lib/commands/portal.js +81 -81
  258. package/lib/commands/publish.d.ts +21 -21
  259. package/lib/commands/publish.js +51 -51
  260. package/lib/commands/pull.d.ts +13 -13
  261. package/lib/commands/pull.js +29 -29
  262. package/lib/commands/push.d.ts +13 -13
  263. package/lib/commands/push.js +29 -29
  264. package/lib/commands/run.d.ts +35 -35
  265. package/lib/commands/run.js +193 -193
  266. package/lib/commands/secretStore/capture.d.ts +27 -27
  267. package/lib/commands/secretStore/capture.js +174 -174
  268. package/lib/commands/secretStore/forget.d.ts +20 -20
  269. package/lib/commands/secretStore/forget.js +146 -146
  270. package/lib/commands/stage.d.ts +13 -13
  271. package/lib/commands/stage.js +64 -64
  272. package/lib/commands/stash.d.ts +13 -13
  273. package/lib/commands/stash.js +30 -30
  274. package/lib/commands/status.d.ts +12 -12
  275. package/lib/commands/status.js +48 -48
  276. package/lib/commands/stop.d.ts +10 -10
  277. package/lib/commands/stop.js +51 -51
  278. package/lib/commands/switch.d.ts +11 -11
  279. package/lib/commands/switch.js +41 -41
  280. package/lib/commands/sync.d.ts +14 -14
  281. package/lib/commands/sync.js +20 -20
  282. package/lib/commands/tenant/create.d.ts +27 -27
  283. package/lib/commands/tenant/create.js +119 -119
  284. package/lib/commands/tenant/switch.d.ts +24 -24
  285. package/lib/commands/tenant/switch.js +108 -108
  286. package/lib/commands/unstage.d.ts +12 -12
  287. package/lib/commands/unstage.js +57 -57
  288. package/lib/commands/view/dashboard.d.ts +17 -0
  289. package/lib/commands/view/dashboard.js +88 -0
  290. package/lib/commands/view/dashboard.js.map +1 -0
  291. package/lib/commands/view/pods.d.ts +14 -0
  292. package/lib/commands/view/pods.js +88 -0
  293. package/lib/commands/view/pods.js.map +1 -0
  294. package/lib/commands/whereami.d.ts +15 -15
  295. package/lib/commands/whereami.js +122 -122
  296. package/lib/commands/whoami.d.ts +8 -8
  297. package/lib/commands/whoami.js +39 -39
  298. package/lib/deployment.d.ts +2 -0
  299. package/lib/deployment.js +7 -0
  300. package/lib/deployment.js.map +1 -0
  301. package/lib/errors/NoMembershipError.d.ts +8 -8
  302. package/lib/errors/NoMembershipError.js +14 -14
  303. package/lib/index.d.ts +1 -1
  304. package/lib/index.js +16 -16
  305. package/lib/k8s-command-base.d.ts +60 -0
  306. package/lib/k8s-command-base.js +204 -0
  307. package/lib/k8s-command-base.js.map +1 -0
  308. package/lib/log-update-wrapper.d.ts +24 -24
  309. package/lib/log-update-wrapper.js +28 -28
  310. package/lib/log4js-logger.d.ts +26 -26
  311. package/lib/log4js-logger.js +137 -137
  312. package/lib/ops/INTERFACES_CLI.d.ts +3 -3
  313. package/lib/ops/INTERFACES_CLI.js +7 -7
  314. package/lib/ops/LocalOps.d.ts +444 -444
  315. package/lib/ops/LocalOps.js +3183 -3183
  316. package/lib/ops/azure-container-registry-client/azure-container-registry-client.js +147 -147
  317. package/lib/ops/cli-path-walker.js +54 -54
  318. package/lib/ops/codiac-entities/dependency.d.ts +5 -5
  319. package/lib/ops/codiac-entities/dependency.js +10 -10
  320. package/lib/ops/codiac-entities/index.d.ts +1 -1
  321. package/lib/ops/codiac-entities/index.js +4 -4
  322. package/lib/ops/composite-image-registry-client.js +73 -73
  323. package/lib/ops/data/cli-context-repo.d.ts +61 -61
  324. package/lib/ops/data/cli-context-repo.js +269 -269
  325. package/lib/ops/data/index.d.ts +2 -2
  326. package/lib/ops/data/index.js +5 -5
  327. package/lib/ops/data/npm-config-repo.d.ts +13 -13
  328. package/lib/ops/data/npm-config-repo.js +64 -64
  329. package/lib/ops/docker-config.js +130 -130
  330. package/lib/ops/docker-constants.js +21 -21
  331. package/lib/ops/docker-credentials-store.js +237 -237
  332. package/lib/ops/docker-registry-api-client/docker-registry-api-client.js +288 -288
  333. package/lib/ops/docker-registry-api-client/entities/blob-sum.d.ts +7 -7
  334. package/lib/ops/docker-registry-api-client/entities/blob-sum.js +12 -12
  335. package/lib/ops/docker-registry-api-client/entities/docker-access-actions-enum.d.ts +5 -5
  336. package/lib/ops/docker-registry-api-client/entities/docker-access-actions-enum.js +9 -9
  337. package/lib/ops/docker-registry-api-client/entities/docker-auth-token-criteria.d.ts +30 -30
  338. package/lib/ops/docker-registry-api-client/entities/docker-auth-token-criteria.js +35 -35
  339. package/lib/ops/docker-registry-api-client/entities/i-docker-error-response.d.ts +55 -55
  340. package/lib/ops/docker-registry-api-client/entities/i-docker-error-response.js +51 -51
  341. package/lib/ops/docker-registry-api-client/entities/i-docker-list-response.d.ts +7 -7
  342. package/lib/ops/docker-registry-api-client/entities/i-docker-list-response.js +2 -2
  343. package/lib/ops/docker-registry-api-client/entities/image-repository.d.ts +31 -31
  344. package/lib/ops/docker-registry-api-client/entities/image-repository.js +29 -29
  345. package/lib/ops/docker-registry-api-client/entities/image-tag-criteria.d.ts +8 -8
  346. package/lib/ops/docker-registry-api-client/entities/image-tag-criteria.js +13 -13
  347. package/lib/ops/docker-registry-api-client/entities/image-tag-list.d.ts +7 -7
  348. package/lib/ops/docker-registry-api-client/entities/image-tag-list.js +12 -12
  349. package/lib/ops/docker-registry-api-client/entities/manifest-criteria.d.ts +9 -9
  350. package/lib/ops/docker-registry-api-client/entities/manifest-criteria.js +14 -14
  351. package/lib/ops/docker-registry-api-client/entities/manifest.d.ts +15 -15
  352. package/lib/ops/docker-registry-api-client/entities/manifest.js +20 -20
  353. package/lib/ops/docker-registry-api-client/entities/repository-criteria.d.ts +16 -16
  354. package/lib/ops/docker-registry-api-client/entities/repository-criteria.js +23 -23
  355. package/lib/ops/docker-registry-api-client/entities/token-response.d.ts +15 -15
  356. package/lib/ops/docker-registry-api-client/entities/token-response.js +14 -14
  357. package/lib/ops/docker-registry-api-client/entities/token.d.ts +17 -17
  358. package/lib/ops/docker-registry-api-client/entities/token.js +21 -21
  359. package/lib/ops/docker-registry-api-client/entities/version-check-criteria.d.ts +4 -4
  360. package/lib/ops/docker-registry-api-client/entities/version-check-criteria.js +9 -9
  361. package/lib/ops/dx-constants.d.ts +26 -26
  362. package/lib/ops/dx-constants.js +42 -42
  363. package/lib/ops/entities/ImageBuildContext.d.ts +12 -12
  364. package/lib/ops/entities/ImageBuildContext.js +18 -18
  365. package/lib/ops/entities/PipelineContext.d.ts +21 -21
  366. package/lib/ops/entities/PipelineContext.js +22 -22
  367. package/lib/ops/entities/TenantContext.d.ts +10 -10
  368. package/lib/ops/entities/TenantContext.js +15 -15
  369. package/lib/ops/entities/ThaulConfig.js +29 -29
  370. package/lib/ops/entities/azure-service-principal.d.ts +23 -23
  371. package/lib/ops/entities/azure-service-principal.js +23 -23
  372. package/lib/ops/entities/better-logger.js +1 -1
  373. package/lib/ops/entities/branch.d.ts +13 -13
  374. package/lib/ops/entities/branch.js +15 -15
  375. package/lib/ops/entities/cli-config.d.ts +48 -48
  376. package/lib/ops/entities/cli-config.js +60 -60
  377. package/lib/ops/entities/docker-image.d.ts +60 -60
  378. package/lib/ops/entities/docker-image.js +2 -2
  379. package/lib/ops/entities/helm-spec.d.ts +15 -15
  380. package/lib/ops/entities/helm-spec.js +22 -22
  381. package/lib/ops/entities/index.d.ts +4 -4
  382. package/lib/ops/entities/index.js +11 -11
  383. package/lib/ops/entities/operation-meta.d.ts +8 -8
  384. package/lib/ops/entities/operation-meta.js +18 -18
  385. package/lib/ops/entities/scaffolding.d.ts +19 -19
  386. package/lib/ops/entities/scaffolding.js +20 -20
  387. package/lib/ops/extensions/azart-identity-adapter.d.ts +19 -19
  388. package/lib/ops/extensions/azart-identity-adapter.js +96 -96
  389. package/lib/ops/extensions/npm-identity-adapter-base.d.ts +13 -13
  390. package/lib/ops/extensions/npm-identity-adapter-base.js +2 -2
  391. package/lib/ops/extensions/npmjs-identity-adapter.d.ts +13 -13
  392. package/lib/ops/extensions/npmjs-identity-adapter.js +63 -63
  393. package/lib/ops/git-ops.d.ts +8 -8
  394. package/lib/ops/git-ops.js +13 -13
  395. package/lib/ops/i-client-for-image-registry.js +16 -16
  396. package/lib/ops/i-identity-handler.d.ts +33 -33
  397. package/lib/ops/i-identity-handler.js +164 -164
  398. package/lib/ops/i-output-styler.js +16 -16
  399. package/lib/ops/index.d.ts +12 -12
  400. package/lib/ops/index.js +14 -14
  401. package/lib/ops/json-utils.js +58 -58
  402. package/lib/ops/no-style-output-styler.js +29 -29
  403. package/lib/ops/oauth2-client.ts/oauth2-client.d.ts +23 -23
  404. package/lib/ops/oauth2-client.ts/oauth2-client.js +63 -63
  405. package/lib/ops/project-initializer.d.ts +36 -36
  406. package/lib/ops/project-initializer.js +218 -218
  407. package/lib/ops/scaffolding/base-scaffolding.d.ts +7 -7
  408. package/lib/ops/scaffolding/base-scaffolding.js +20 -20
  409. package/lib/ops/scaffolding/codiac-api-scaffolding.d.ts +7 -7
  410. package/lib/ops/scaffolding/codiac-api-scaffolding.js +63 -63
  411. package/lib/ops/scaffolding/typescript-scaffolding.d.ts +15 -15
  412. package/lib/ops/scaffolding/typescript-scaffolding.js +162 -162
  413. package/lib/ops/test/mock-ui.d.ts +26 -26
  414. package/lib/ops/test/mock-ui.js +87 -87
  415. package/lib/ops/test/test-extensions.d.ts +13 -13
  416. package/lib/ops/test/test-extensions.js +70 -70
  417. package/lib/ops/test/when-a-recursive-file-search-is-run.spec.d.ts +2 -2
  418. package/lib/ops/test/when-a-recursive-file-search-is-run.spec.js +54 -54
  419. package/lib/ops/test/when-git-branchline-is-attempted.spec.d.ts +2 -2
  420. package/lib/ops/test/when-git-branchline-is-attempted.spec.js +37 -37
  421. package/lib/ops/test/when-versions-are-parsed.spec.d.ts +2 -2
  422. package/lib/ops/test/when-versions-are-parsed.spec.js +59 -59
  423. package/lib/ops/throwing-user-input-provider.js +36 -36
  424. package/lib/prettify.d.ts +7 -7
  425. package/lib/prettify.js +23 -23
  426. package/lib/read-stdin.d.ts +2 -2
  427. package/lib/read-stdin.js +28 -28
  428. package/lib/relay/contracts/contracts.d.ts +207 -207
  429. package/lib/relay/contracts/contracts.js +229 -229
  430. package/lib/relay/data/aws-k8s-versions.d.ts +6 -0
  431. package/lib/relay/data/aws-k8s-versions.js +16 -0
  432. package/lib/relay/data/aws-k8s-versions.js.map +1 -0
  433. package/lib/relay/data/aws-node-types.d.ts +37 -0
  434. package/lib/relay/data/aws-node-types.js +4246 -0
  435. package/lib/relay/data/aws-node-types.js.map +1 -0
  436. package/lib/relay/data/aws-regions.d.ts +6 -0
  437. package/lib/relay/data/aws-regions.js +34 -0
  438. package/lib/relay/data/aws-regions.js.map +1 -0
  439. package/lib/relay/extended-relay-client.d.ts +27 -27
  440. package/lib/relay/extended-relay-client.js +27 -27
  441. package/lib/relay/relay-container.d.ts +41 -41
  442. package/lib/relay/relay-container.js +297 -297
  443. package/lib/relay/wsclient/relay-socket-listener.d.ts +68 -68
  444. package/lib/relay/wsclient/relay-socket-listener.js +164 -164
  445. package/lib/relay/wsclient/relay-websocket-client.d.ts +33 -33
  446. package/lib/relay/wsclient/relay-websocket-client.js +178 -178
  447. package/lib/relay/wsclient/rx-websocket-subject.d.ts +25 -25
  448. package/lib/relay/wsclient/rx-websocket-subject.js +133 -133
  449. package/lib/relay/wsclient/socket-contracts.d.ts +22 -22
  450. package/lib/relay/wsclient/socket-contracts.js +2 -2
  451. package/lib/standard-probes.d.ts +5 -5
  452. package/lib/standard-probes.js +21 -21
  453. package/lib/uilogic/build-configurator.d.ts +21 -21
  454. package/lib/uilogic/build-configurator.js +110 -110
  455. package/lib/uilogic/cloud-provider-contextualizer.d.ts +46 -46
  456. package/lib/uilogic/cloud-provider-contextualizer.js +193 -193
  457. package/lib/uilogic/cloud-resource-configurator-factory.d.ts +41 -41
  458. package/lib/uilogic/cloud-resource-configurator-factory.js +157 -157
  459. package/lib/uilogic/cloud-resource-configurators/aws-k8s-versions.d.ts +11 -0
  460. package/lib/uilogic/cloud-resource-configurators/aws-k8s-versions.js +16 -0
  461. package/lib/uilogic/cloud-resource-configurators/aws-k8s-versions.js.map +1 -0
  462. package/lib/uilogic/cloud-resource-configurators/aws-node-types.d.ts +5 -0
  463. package/lib/uilogic/cloud-resource-configurators/aws-node-types.js +536 -0
  464. package/lib/uilogic/cloud-resource-configurators/aws-node-types.js.map +1 -0
  465. package/lib/uilogic/cloud-resource-configurators/aws-regions.d.ts +10 -0
  466. package/lib/uilogic/cloud-resource-configurators/aws-regions.js +34 -0
  467. package/lib/uilogic/cloud-resource-configurators/aws-regions.js.map +1 -0
  468. package/lib/uilogic/cloud-resource-configurators/aws-resource-configurator.d.ts +38 -38
  469. package/lib/uilogic/cloud-resource-configurators/aws-resource-configurator.js +347 -347
  470. package/lib/uilogic/cloud-resource-configurators/az-acr-cli-authenticator.js +77 -77
  471. package/lib/uilogic/cloud-resource-configurators/az-interactive-login-configurator.d.ts +42 -42
  472. package/lib/uilogic/cloud-resource-configurators/az-interactive-login-configurator.js +247 -247
  473. package/lib/uilogic/cloud-resource-configurators/azure-resource-configurator.d.ts +110 -110
  474. package/lib/uilogic/cloud-resource-configurators/azure-resource-configurator.js +781 -781
  475. package/lib/uilogic/cloud-resource-configurators/azure-types.js +9 -9
  476. package/lib/uilogic/cloud-resource-configurators/docker-hub-resource-configurator.d.ts +24 -24
  477. package/lib/uilogic/cloud-resource-configurators/docker-hub-resource-configurator.js +105 -105
  478. package/lib/uilogic/cloud-resource-configurators/helm-resource-configurator.d.ts +16 -16
  479. package/lib/uilogic/cloud-resource-configurators/helm-resource-configurator.js +44 -44
  480. package/lib/uilogic/cloud-resource-configurators/unsupported-resource-configurator.d.ts +18 -18
  481. package/lib/uilogic/cloud-resource-configurators/unsupported-resource-configurator.js +61 -61
  482. package/lib/uilogic/enterprise-contextualizer.d.ts +76 -76
  483. package/lib/uilogic/enterprise-contextualizer.js +670 -670
  484. package/lib/uilogic/environment-contextualizer.d.ts +15 -15
  485. package/lib/uilogic/environment-contextualizer.js +42 -42
  486. package/lib/uilogic/i-cluster-configurator.d.ts +9 -9
  487. package/lib/uilogic/i-cluster-configurator.js +2 -2
  488. package/lib/uilogic/i-login-configurator.d.ts +6 -6
  489. package/lib/uilogic/i-login-configurator.js +2 -2
  490. package/lib/uilogic/i-registry-configurator.d.ts +6 -6
  491. package/lib/uilogic/i-registry-configurator.js +2 -2
  492. package/lib/uilogic/i-secret-store-configurator.d.ts +7 -7
  493. package/lib/uilogic/i-secret-store-configurator.js +2 -2
  494. package/lib/uilogic/image-configurator.d.ts +133 -133
  495. package/lib/uilogic/image-configurator.js +577 -577
  496. package/lib/uilogic/image-contextualizer.d.ts +24 -24
  497. package/lib/uilogic/image-contextualizer.js +89 -89
  498. package/lib/uilogic/image-registry-contextualizer.d.ts +28 -28
  499. package/lib/uilogic/image-registry-contextualizer.js +126 -126
  500. package/lib/uilogic/index.d.ts +9 -9
  501. package/lib/uilogic/index.js +13 -13
  502. package/lib/uilogic/prompt-select-fuzzy.js +138 -138
  503. package/lib/uilogic/render-methods.d.ts +12 -12
  504. package/lib/uilogic/render-methods.js +64 -64
  505. package/lib/uilogic/tenant-contextualizer.d.ts +79 -79
  506. package/lib/uilogic/tenant-contextualizer.js +573 -573
  507. package/lib/user-context-loader.d.ts +60 -60
  508. package/lib/user-context-loader.js +183 -183
  509. package/oclif.manifest.json +45 -1
  510. package/package.json +150 -150
  511. package/scaffolding/api/.gitignore-scaffolding +68 -68
  512. package/scaffolding/api/.vscode/launch.json +16 -16
  513. package/scaffolding/api/.vscode/settings.json +7 -7
  514. package/scaffolding/api/.vscode/tasks.json +15 -15
  515. package/scaffolding/api/src/app-config.json +2 -2
  516. package/scaffolding/api/src/index.ts-scaffolding +13 -13
  517. package/scaffolding/api/src/myApiDef.ts-scaffolding +25 -25
  518. package/scaffolding/default/.gitignore-scaffolding +2 -2
  519. package/scaffolding/typescript/.gitignore-scaffolding +69 -69
  520. package/scaffolding/typescript/.vscode/launch.json +16 -16
  521. package/scaffolding/typescript/.vscode/settings.json +7 -7
  522. package/scaffolding/typescript/.vscode/tasks.json +15 -15
package/README.md CHANGED
@@ -1,37 +1,60 @@
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
-
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
11
  <!-- toc -->
12
12
  * [Codiac-CLI](#codiac-cli-1)
13
13
  * [Usage](#usage)
14
14
  * [Commands](#commands)
15
- <!-- tocstop -->
16
-
17
- # Usage
18
-
15
+ <!-- tocstop -->
16
+
17
+ - [Codiac-CLI](#codiac-cli-1)
18
+ - [Usage](#usage)
19
+ - [Commands](#commands)
20
+ <!-- tocstop -->
21
+ - [Codiac-CLI](#codiac-cli)
22
+ - [Usage](#usage)
23
+ - [Commands](#commands)
24
+ <!-- tocstop -->
25
+
26
+ # Usage
27
+
19
28
  <!-- usage -->
20
29
  ```sh-session
21
30
  $ npm install -g @codiac.io/codiac-cli
22
31
  $ codiac COMMAND
23
32
  running command...
24
33
  $ codiac (--version|-v)
25
- @codiac.io/codiac-cli/1.2.167 linux-x64 node-v16.20.0
34
+ @codiac.io/codiac-cli/1.2.169 win32-x64 node-v16.17.1
26
35
  $ codiac --help [COMMAND]
27
36
  USAGE
28
37
  $ codiac COMMAND
29
38
  ...
30
39
  ```
31
- <!-- usagestop -->
32
-
33
- # Commands
34
-
40
+ <!-- usagestop -->
41
+
42
+ ```sh-session
43
+ $ npm install -g @codiac.io/codiac-cli
44
+ $ codiac COMMAND
45
+ running command...
46
+ $ codiac (--version|-v)
47
+ @codiac.io/codiac-cli/1.2.167 linux-x64 node-v16.20.0
48
+ $ codiac --help [COMMAND]
49
+ USAGE
50
+ $ codiac COMMAND
51
+ ...
52
+ ```
53
+
54
+ <!-- usagestop -->
55
+
56
+ # Commands
57
+
35
58
  <!-- commands -->
36
59
  * [`codiac asset create`](#codiac-asset-create)
37
60
  * [`codiac asset destroy`](#codiac-asset-destroy)
@@ -91,6 +114,7 @@ USAGE
91
114
  * [`codiac config view [SETTING]`](#codiac-config-view-setting)
92
115
  * [`codiac csp login [PROVIDER]`](#codiac-csp-login-provider)
93
116
  * [`codiac csp logout [PROVIDER]`](#codiac-csp-logout-provider)
117
+ * [`codiac dash`](#codiac-dash)
94
118
  * [`codiac dep [NAME]`](#codiac-dep-name)
95
119
  * [`codiac dep create [URL]`](#codiac-dep-create-url)
96
120
  * [`codiac dep install`](#codiac-dep-install)
@@ -143,6 +167,7 @@ USAGE
143
167
  * [`codiac img patch IMAGENAME`](#codiac-img-patch-imagename)
144
168
  * [`codiac img remove IMAGENAME`](#codiac-img-remove-imagename)
145
169
  * [`codiac init DIRECTORY`](#codiac-init-directory)
170
+ * [`codiac k9s`](#codiac-k9s)
146
171
  * [`codiac kit create [SETTING]`](#codiac-kit-create-setting)
147
172
  * [`codiac login`](#codiac-login)
148
173
  * [`codiac logout`](#codiac-logout)
@@ -187,6 +212,10 @@ USAGE
187
212
  * [`codiac user login`](#codiac-user-login)
188
213
  * [`codiac user show`](#codiac-user-show)
189
214
  * [`codiac version`](#codiac-version)
215
+ * [`codiac view dash`](#codiac-view-dash)
216
+ * [`codiac view dashboard`](#codiac-view-dashboard)
217
+ * [`codiac view k9s`](#codiac-view-k9s)
218
+ * [`codiac view pods`](#codiac-view-pods)
190
219
  * [`codiac whereami`](#codiac-whereami)
191
220
  * [`codiac whoami`](#codiac-whoami)
192
221
 
@@ -1010,7 +1039,7 @@ DESCRIPTION
1010
1039
  Creates a new branch for the parent project and any sourced dependencies.
1011
1040
  ```
1012
1041
 
1013
- _See code: [src/commands/branch.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/branch.ts)_
1042
+ _See code: [src/commands/branch.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/branch.ts)_
1014
1043
 
1015
1044
  ## `codiac branch current`
1016
1045
 
@@ -1135,7 +1164,7 @@ DESCRIPTION
1135
1164
  Builds the project and the docker container
1136
1165
  ```
1137
1166
 
1138
- _See code: [src/commands/build.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/build.ts)_
1167
+ _See code: [src/commands/build.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/build.ts)_
1139
1168
 
1140
1169
  ## `codiac cab create [CABINET]`
1141
1170
 
@@ -1429,7 +1458,7 @@ DESCRIPTION
1429
1458
  Applies settings to the Codiac CLI itself (scoped to the local machine).
1430
1459
  ```
1431
1460
 
1432
- _See code: [src/commands/cli.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/cli.ts)_
1461
+ _See code: [src/commands/cli.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/cli.ts)_
1433
1462
 
1434
1463
  ## `codiac cluster create [NAME]`
1435
1464
 
@@ -1670,7 +1699,7 @@ DESCRIPTION
1670
1699
  Commits the currently staged changes on the current branch of the main project and on any sourced dependencies.
1671
1700
  ```
1672
1701
 
1673
- _See code: [src/commands/commit.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/commit.ts)_
1702
+ _See code: [src/commands/commit.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/commit.ts)_
1674
1703
 
1675
1704
  ## `codiac config add [SETTING]`
1676
1705
 
@@ -1911,6 +1940,25 @@ EXAMPLES
1911
1940
  cod csp logout --silent azure
1912
1941
  ```
1913
1942
 
1943
+ ## `codiac dash`
1944
+
1945
+ Spins up the dashboard for a given cabinet
1946
+
1947
+ ```
1948
+ USAGE
1949
+ $ codiac dash [-h]
1950
+
1951
+ FLAGS
1952
+ -h, --help Show CLI help.
1953
+
1954
+ DESCRIPTION
1955
+ Spins up the dashboard for a given cabinet
1956
+
1957
+ ALIASES
1958
+ $ codiac view dash
1959
+ $ codiac dash
1960
+ ```
1961
+
1914
1962
  ## `codiac dep [NAME]`
1915
1963
 
1916
1964
  Installs a package into current project.
@@ -1930,7 +1978,7 @@ DESCRIPTION
1930
1978
  Installs a package into current project.
1931
1979
  ```
1932
1980
 
1933
- _See code: [src/commands/dep.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/dep.ts)_
1981
+ _See code: [src/commands/dep.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/dep.ts)_
1934
1982
 
1935
1983
  ## `codiac dep create [URL]`
1936
1984
 
@@ -2165,7 +2213,7 @@ DESCRIPTION
2165
2213
  Deploys a given asset to a given cabinet. Defaults to current version.
2166
2214
  ```
2167
2215
 
2168
- _See code: [src/commands/deploy.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/deploy.ts)_
2216
+ _See code: [src/commands/deploy.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/deploy.ts)_
2169
2217
 
2170
2218
  ## `codiac domain map [DOMAIN]`
2171
2219
 
@@ -2578,7 +2626,7 @@ ALIASES
2578
2626
  $ codiac token
2579
2627
  ```
2580
2628
 
2581
- _See code: [src/commands/identity.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/identity.ts)_
2629
+ _See code: [src/commands/identity.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/identity.ts)_
2582
2630
 
2583
2631
  ## `codiac identity delete [NAME]`
2584
2632
 
@@ -3375,7 +3423,26 @@ DESCRIPTION
3375
3423
  Declares the given folder as a project root
3376
3424
  ```
3377
3425
 
3378
- _See code: [src/commands/init.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/init.ts)_
3426
+ _See code: [src/commands/init.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/init.ts)_
3427
+
3428
+ ## `codiac k9s`
3429
+
3430
+ Spins up the k9s cli pod viewer
3431
+
3432
+ ```
3433
+ USAGE
3434
+ $ codiac k9s [-h]
3435
+
3436
+ FLAGS
3437
+ -h, --help Show CLI help.
3438
+
3439
+ DESCRIPTION
3440
+ Spins up the k9s cli pod viewer
3441
+
3442
+ ALIASES
3443
+ $ codiac view k9s
3444
+ $ codiac k9s
3445
+ ```
3379
3446
 
3380
3447
  ## `codiac kit create [SETTING]`
3381
3448
 
@@ -3435,7 +3502,7 @@ ALIASES
3435
3502
  $ codiac user login
3436
3503
  ```
3437
3504
 
3438
- _See code: [src/commands/login.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/login.ts)_
3505
+ _See code: [src/commands/login.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/login.ts)_
3439
3506
 
3440
3507
  ## `codiac logout`
3441
3508
 
@@ -3452,7 +3519,7 @@ EXAMPLES
3452
3519
  $ codiac logout
3453
3520
  ```
3454
3521
 
3455
- _See code: [src/commands/logout.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/logout.ts)_
3522
+ _See code: [src/commands/logout.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/logout.ts)_
3456
3523
 
3457
3524
  ## `codiac merge [BRANCH]`
3458
3525
 
@@ -3473,7 +3540,7 @@ DESCRIPTION
3473
3540
  Merges the given branch into the current branch of the main project and on any sourced dependencies.
3474
3541
  ```
3475
3542
 
3476
- _See code: [src/commands/merge.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/merge.ts)_
3543
+ _See code: [src/commands/merge.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/merge.ts)_
3477
3544
 
3478
3545
  ## `codiac noc cluster create [NAME]`
3479
3546
 
@@ -3821,7 +3888,7 @@ DESCRIPTION
3821
3888
  Starts the codiac relay services, maintains container instance, and opens the web app.
3822
3889
  ```
3823
3890
 
3824
- _See code: [src/commands/portal.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/portal.ts)_
3891
+ _See code: [src/commands/portal.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/portal.ts)_
3825
3892
 
3826
3893
  ## `codiac publish [NAME]`
3827
3894
 
@@ -3854,7 +3921,7 @@ DESCRIPTION
3854
3921
  Publishes the exports (packages and images) declared in the ProjectConfig.
3855
3922
  ```
3856
3923
 
3857
- _See code: [src/commands/publish.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/publish.ts)_
3924
+ _See code: [src/commands/publish.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/publish.ts)_
3858
3925
 
3859
3926
  ## `codiac pull [NAME]`
3860
3927
 
@@ -3878,7 +3945,7 @@ DESCRIPTION
3878
3945
  Pulls all commits from upstream to local.
3879
3946
  ```
3880
3947
 
3881
- _See code: [src/commands/pull.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/pull.ts)_
3948
+ _See code: [src/commands/pull.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/pull.ts)_
3882
3949
 
3883
3950
  ## `codiac pullsecret`
3884
3951
 
@@ -3961,7 +4028,7 @@ DESCRIPTION
3961
4028
  Pushes all local commits upstream.
3962
4029
  ```
3963
4030
 
3964
- _See code: [src/commands/push.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/push.ts)_
4031
+ _See code: [src/commands/push.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/push.ts)_
3965
4032
 
3966
4033
  ## `codiac run`
3967
4034
 
@@ -4003,7 +4070,7 @@ DESCRIPTION
4003
4070
  Runs the latest build of the api container locally.
4004
4071
  ```
4005
4072
 
4006
- _See code: [src/commands/run.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/run.ts)_
4073
+ _See code: [src/commands/run.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/run.ts)_
4007
4074
 
4008
4075
  ## `codiac secretStore`
4009
4076
 
@@ -4104,7 +4171,7 @@ DESCRIPTION
4104
4171
  Flags files to be included in the next commit.
4105
4172
  ```
4106
4173
 
4107
- _See code: [src/commands/stage.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/stage.ts)_
4174
+ _See code: [src/commands/stage.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/stage.ts)_
4108
4175
 
4109
4176
  ## `codiac stash [FILE]`
4110
4177
 
@@ -4126,7 +4193,7 @@ DESCRIPTION
4126
4193
  describe the command here
4127
4194
  ```
4128
4195
 
4129
- _See code: [src/commands/stash.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/stash.ts)_
4196
+ _See code: [src/commands/stash.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/stash.ts)_
4130
4197
 
4131
4198
  ## `codiac status`
4132
4199
 
@@ -4145,7 +4212,7 @@ DESCRIPTION
4145
4212
  Shows the current uncommitted changes in the current branch.
4146
4213
  ```
4147
4214
 
4148
- _See code: [src/commands/status.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/status.ts)_
4215
+ _See code: [src/commands/status.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/status.ts)_
4149
4216
 
4150
4217
  ## `codiac stop`
4151
4218
 
@@ -4163,7 +4230,7 @@ DESCRIPTION
4163
4230
  Stops the running container for this project
4164
4231
  ```
4165
4232
 
4166
- _See code: [src/commands/stop.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/stop.ts)_
4233
+ _See code: [src/commands/stop.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/stop.ts)_
4167
4234
 
4168
4235
  ## `codiac switch [NAME]`
4169
4236
 
@@ -4183,7 +4250,7 @@ DESCRIPTION
4183
4250
  Changes branch on the main project and any sourced dependencies.
4184
4251
  ```
4185
4252
 
4186
- _See code: [src/commands/switch.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/switch.ts)_
4253
+ _See code: [src/commands/switch.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/switch.ts)_
4187
4254
 
4188
4255
  ## `codiac sync [NAME]`
4189
4256
 
@@ -4208,7 +4275,7 @@ DESCRIPTION
4208
4275
  Merges the given branch into the current branch.
4209
4276
  ```
4210
4277
 
4211
- _See code: [src/commands/sync.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/sync.ts)_
4278
+ _See code: [src/commands/sync.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/sync.ts)_
4212
4279
 
4213
4280
  ## `codiac tenant create [NAME]`
4214
4281
 
@@ -4390,7 +4457,7 @@ DESCRIPTION
4390
4457
  Flags files to be included in the next commit.
4391
4458
  ```
4392
4459
 
4393
- _See code: [src/commands/unstage.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/unstage.ts)_
4460
+ _See code: [src/commands/unstage.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/unstage.ts)_
4394
4461
 
4395
4462
  ## `codiac update [CHANNEL]`
4396
4463
 
@@ -4427,7 +4494,7 @@ EXAMPLES
4427
4494
  $ codiac update --available
4428
4495
  ```
4429
4496
 
4430
- _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v3.1.18/src/commands/update.ts)_
4497
+ _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v3.1.17/src/commands/update.ts)_
4431
4498
 
4432
4499
  ## `codiac user login`
4433
4500
 
@@ -4494,6 +4561,82 @@ FLAG DESCRIPTIONS
4494
4561
 
4495
4562
  _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.3.4/src/commands/version.ts)_
4496
4563
 
4564
+ ## `codiac view dash`
4565
+
4566
+ Spins up the dashboard for a given cabinet
4567
+
4568
+ ```
4569
+ USAGE
4570
+ $ codiac view dash [-h]
4571
+
4572
+ FLAGS
4573
+ -h, --help Show CLI help.
4574
+
4575
+ DESCRIPTION
4576
+ Spins up the dashboard for a given cabinet
4577
+
4578
+ ALIASES
4579
+ $ codiac view dash
4580
+ $ codiac dash
4581
+ ```
4582
+
4583
+ ## `codiac view dashboard`
4584
+
4585
+ Spins up the dashboard for a given cabinet
4586
+
4587
+ ```
4588
+ USAGE
4589
+ $ codiac view dashboard [-h]
4590
+
4591
+ FLAGS
4592
+ -h, --help Show CLI help.
4593
+
4594
+ DESCRIPTION
4595
+ Spins up the dashboard for a given cabinet
4596
+
4597
+ ALIASES
4598
+ $ codiac view dash
4599
+ $ codiac dash
4600
+ ```
4601
+
4602
+ ## `codiac view k9s`
4603
+
4604
+ Spins up the k9s cli pod viewer
4605
+
4606
+ ```
4607
+ USAGE
4608
+ $ codiac view k9s [-h]
4609
+
4610
+ FLAGS
4611
+ -h, --help Show CLI help.
4612
+
4613
+ DESCRIPTION
4614
+ Spins up the k9s cli pod viewer
4615
+
4616
+ ALIASES
4617
+ $ codiac view k9s
4618
+ $ codiac k9s
4619
+ ```
4620
+
4621
+ ## `codiac view pods`
4622
+
4623
+ Spins up the k9s cli pod viewer
4624
+
4625
+ ```
4626
+ USAGE
4627
+ $ codiac view pods [-h]
4628
+
4629
+ FLAGS
4630
+ -h, --help Show CLI help.
4631
+
4632
+ DESCRIPTION
4633
+ Spins up the k9s cli pod viewer
4634
+
4635
+ ALIASES
4636
+ $ codiac view k9s
4637
+ $ codiac k9s
4638
+ ```
4639
+
4497
4640
  ## `codiac whereami`
4498
4641
 
4499
4642
  Renders the current cabinet context the image project is pointed to. ie: Tenant, Enterprise, Environment, Cabinet.
@@ -4511,7 +4654,7 @@ DESCRIPTION
4511
4654
  Renders the current cabinet context the image project is pointed to. ie: Tenant, Enterprise, Environment, Cabinet.
4512
4655
  ```
4513
4656
 
4514
- _See code: [src/commands/whereami.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/whereami.ts)_
4657
+ _See code: [src/commands/whereami.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/whereami.ts)_
4515
4658
 
4516
4659
  ## `codiac whoami`
4517
4660
 
@@ -4528,5 +4671,3143 @@ ALIASES
4528
4671
  $ codiac user show
4529
4672
  ```
4530
4673
 
4531
- _See code: [src/commands/whoami.ts](https://github.com/codiac/codiac-cli/blob/v1.2.167/src/commands/whoami.ts)_
4674
+ _See code: [src/commands/whoami.ts](https://github.com/codiac/codiac-cli/blob/v1.2.169/src/commands/whoami.ts)_
4675
+ <!-- commandsstop -->
4676
+
4677
+ - [`codiac asset create`](#codiac-asset-create)
4678
+ - [`codiac asset destroy`](#codiac-asset-destroy)
4679
+ - [`codiac asset helm [SETTING]`](#codiac-asset-helm-setting)
4680
+ - [`codiac asset new`](#codiac-asset-new)
4681
+ - [`codiac asset recycle`](#codiac-asset-recycle)
4682
+ - [`codiac asset vol add [MOUNTPATH]`](#codiac-asset-vol-add-mountpath)
4683
+ - [`codiac asset vol create [MOUNTPATH]`](#codiac-asset-vol-create-mountpath)
4684
+ - [`codiac asset vol del`](#codiac-asset-vol-del)
4685
+ - [`codiac asset vol delete`](#codiac-asset-vol-delete)
4686
+ - [`codiac asset volume add [MOUNTPATH]`](#codiac-asset-volume-add-mountpath)
4687
+ - [`codiac asset volume create [MOUNTPATH]`](#codiac-asset-volume-create-mountpath)
4688
+ - [`codiac asset volume del`](#codiac-asset-volume-del)
4689
+ - [`codiac asset volume delete`](#codiac-asset-volume-delete)
4690
+ - [`codiac asset volumes del`](#codiac-asset-volumes-del)
4691
+ - [`codiac asset volumes delete`](#codiac-asset-volumes-delete)
4692
+ - [`codiac autocomplete [SHELL]`](#codiac-autocomplete-shell)
4693
+ - [`codiac branch [NAME]`](#codiac-branch-name)
4694
+ - [`codiac branch current`](#codiac-branch-current)
4695
+ - [`codiac branch list`](#codiac-branch-list)
4696
+ - [`codiac branches current`](#codiac-branches-current)
4697
+ - [`codiac branches list`](#codiac-branches-list)
4698
+ - [`codiac cab create [CABINET]`](#codiac-cab-create-cabinet)
4699
+ - [`codiac cab obliterate [CABINET]`](#codiac-cab-obliterate-cabinet)
4700
+ - [`codiac cabinet create [CABINET]`](#codiac-cabinet-create-cabinet)
4701
+ - [`codiac cabinet obliterate [CABINET]`](#codiac-cabinet-obliterate-cabinet)
4702
+ - [`codiac cfg add [SETTING]`](#codiac-cfg-add-setting)
4703
+ - [`codiac cfg delete [SETTING]`](#codiac-cfg-delete-setting)
4704
+ - [`codiac cli`](#codiac-cli)
4705
+ - [`codiac cluster create [NAME]`](#codiac-cluster-create-name)
4706
+ - [`codiac commit [MESSAGE]`](#codiac-commit-message)
4707
+ - [`codiac config add [SETTING]`](#codiac-config-add-setting)
4708
+ - [`codiac config delete [SETTING]`](#codiac-config-delete-setting)
4709
+ - [`codiac config deploy`](#codiac-config-deploy)
4710
+ - [`codiac config import [SETTING]`](#codiac-config-import-setting)
4711
+ - [`codiac config set [SETTING]`](#codiac-config-set-setting)
4712
+ - [`codiac csp login [PROVIDER]`](#codiac-csp-login-provider)
4713
+ - [`codiac csp logout [PROVIDER]`](#codiac-csp-logout-provider)
4714
+ - [`codiac dash`](#codiac-dash)
4715
+ - [`codiac dep [NAME]`](#codiac-dep-name)
4716
+ - [`codiac dep create [URL]`](#codiac-dep-create-url)
4717
+ - [`codiac dep install`](#codiac-dep-install)
4718
+ - [`codiac dep list`](#codiac-dep-list)
4719
+ - [`codiac dep remove [NAME]`](#codiac-dep-remove-name)
4720
+ - [`codiac dep source [NAME]`](#codiac-dep-source-name)
4721
+ - [`codiac dep src [NAME]`](#codiac-dep-src-name)
4722
+ - [`codiac dep syncup [DEPENDENCY]`](#codiac-dep-syncup-dependency)
4723
+ - [`codiac dep unsource [NAME]`](#codiac-dep-unsource-name)
4724
+ - [`codiac dep unsrc [NAME]`](#codiac-dep-unsrc-name)
4725
+ - [`codiac dep upgrade [DEPENDENCY]`](#codiac-dep-upgrade-dependency)
4726
+ - [`codiac deploy`](#codiac-deploy)
4727
+ - [`codiac domain map [DOMAIN]`](#codiac-domain-map-domain)
4728
+ - [`codiac enterprise create [CODE]`](#codiac-enterprise-create-code)
4729
+ - [`codiac env add [SETTING]`](#codiac-env-add-setting)
4730
+ - [`codiac enviro create [NAME]`](#codiac-enviro-create-name)
4731
+ - [`codiac environment create [NAME]`](#codiac-environment-create-name)
4732
+ - [`codiac fileshare capture`](#codiac-fileshare-capture)
4733
+ - [`codiac filestore capture`](#codiac-filestore-capture)
4734
+ - [`codiac help [COMMANDS]`](#codiac-help-commands)
4735
+ - [`codiac host map [DOMAIN]`](#codiac-host-map-domain)
4736
+ - [`codiac identity delete [NAME]`](#codiac-identity-delete-name)
4737
+ - [`codiac identity remove [NAME]`](#codiac-identity-remove-name)
4738
+ - [`codiac image [IMAGENAME]`](#codiac-image-imagename)
4739
+ - [`codiac image add [IMAGENAME]`](#codiac-image-add-imagename)
4740
+ - [`codiac image delete IMAGENAME`](#codiac-image-delete-imagename)
4741
+ - [`codiac image patch IMAGENAME`](#codiac-image-patch-imagename)
4742
+ - [`codiac image remove IMAGENAME`](#codiac-image-remove-imagename)
4743
+ - [`codiac imageRegistry forget`](#codiac-imageregistry-forget)
4744
+ - [`codiac images add [IMAGENAME]`](#codiac-images-add-imagename)
4745
+ - [`codiac images patch IMAGENAME`](#codiac-images-patch-imagename)
4746
+ - [`codiac images remove IMAGENAME`](#codiac-images-remove-imagename)
4747
+ - [`codiac img [IMAGENAME]`](#codiac-img-imagename)
4748
+ - [`codiac img add [IMAGENAME]`](#codiac-img-add-imagename)
4749
+ - [`codiac img delete IMAGENAME`](#codiac-img-delete-imagename)
4750
+ - [`codiac img patch IMAGENAME`](#codiac-img-patch-imagename)
4751
+ - [`codiac img remove IMAGENAME`](#codiac-img-remove-imagename)
4752
+ - [`codiac init DIRECTORY`](#codiac-init-directory)
4753
+ - [`codiac k9s`](#codiac-k9s)
4754
+ - [`codiac kit create [SETTING]`](#codiac-kit-create-setting)
4755
+ - [`codiac login`](#codiac-login)
4756
+ - [`codiac logout`](#codiac-logout)
4757
+ - [`codiac merge [BRANCH]`](#codiac-merge-branch)
4758
+ - [`codiac noc cluster create [NAME]`](#codiac-noc-cluster-create-name)
4759
+ - [`codiac pkg add [DEFINITIONFILE]`](#codiac-pkg-add-definitionfile)
4760
+ - [`codiac pkg delete [PACKAGENAME]`](#codiac-pkg-delete-packagename)
4761
+ - [`codiac pkg list [HELLO]`](#codiac-pkg-list-hello)
4762
+ - [`codiac pkg patch PACKAGENAME`](#codiac-pkg-patch-packagename)
4763
+ - [`codiac pkg remove [PACKAGENAME]`](#codiac-pkg-remove-packagename)
4764
+ - [`codiac portal`](#codiac-portal)
4765
+ - [`codiac publish [NAME]`](#codiac-publish-name)
4766
+ - [`codiac pull [NAME]`](#codiac-pull-name)
4767
+ - [`codiac push [NAME]`](#codiac-push-name)
4768
+ - [`codiac run`](#codiac-run)
4769
+ - [`codiac secretStore forget`](#codiac-secretstore-forget)
4770
+ - [`codiac stage [FILES]`](#codiac-stage-files)
4771
+ - [`codiac stash [FILE]`](#codiac-stash-file)
4772
+ - [`codiac status`](#codiac-status)
4773
+ - [`codiac stop`](#codiac-stop)
4774
+ - [`codiac switch [NAME]`](#codiac-switch-name)
4775
+ - [`codiac sync [NAME]`](#codiac-sync-name)
4776
+ - [`codiac tenant create [NAME]`](#codiac-tenant-create-name)
4777
+ - [`codiac tenant switch [NAME]`](#codiac-tenant-switch-name)
4778
+ - [`codiac token delete [NAME]`](#codiac-token-delete-name)
4779
+ - [`codiac token remove [NAME]`](#codiac-token-remove-name)
4780
+ - [`codiac unstage [FILES]`](#codiac-unstage-files)
4781
+ - [`codiac update [CHANNEL]`](#codiac-update-channel)
4782
+ - [`codiac user login`](#codiac-user-login)
4783
+ - [`codiac version`](#codiac-version)
4784
+ - [`codiac view dash`](#codiac-view-dash)
4785
+ - [`codiac view dashboard`](#codiac-view-dashboard)
4786
+ - [`codiac view k9s`](#codiac-view-k9s)
4787
+ - [`codiac view pods`](#codiac-view-pods)
4788
+ - [`codiac whereami [FILE]`](#codiac-whereami-file)
4789
+
4790
+ ## `codiac asset create`
4791
+
4792
+ Creates a new asset in the given enterprise from an image that exists in a container registry.
4793
+
4794
+ ```
4795
+ USAGE
4796
+ $ codiac asset create [-h] [-k <value> | -i <value> | -r <value>] [-g] [-o] [-t] [-y -n <value> -c <value> -e
4797
+ <value> -p <value>]
4798
+
4799
+ FLAGS
4800
+ -c, --code=<value> The host name to assign this asset in the domain url. eg: 'myasset' in
4801
+ 'myasset.your-domain.com' (Optional: defaults to the asset name).
4802
+ -e, --enterprise=<value> The name of the enterprise in which to create this asset. (defaults to the current
4803
+ enterprise context)
4804
+ -g, --hasIngress Declaration that the asset service is to be externally accessible (optional: defaults to
4805
+ false).
4806
+ -h, --help Show CLI help.
4807
+ -i, --image=<value> The image name including scope prefix if applicable (eg: '@yourCompany/your-api-image').
4808
+ -k, --kit=<value> The name of the kit (with library prefix, eg: 'library/kitName') to use to create the asset.
4809
+ Use '?' to be prompted for a kit (Optional: used instead of calling for the image).
4810
+ -n, --name=<value> The name to give the enterprise asset (Optional: defaults to the image name without the
4811
+ scope prefix).
4812
+ -o, --routedWithoutName Indicates that this asset will be the base ingress against your DNS. eg: true services
4813
+ yourwebsite.com (as root/naked) (optional: defaults to false).
4814
+ -p, --port=<value> The default port to assign the asset when deployed to a cabinet (optional).
4815
+ -r, --registry=<value> The container registry in which the image exists (defaults to docker hub).
4816
+ -t, --toScript Outputs an assembled command string, NO execution
4817
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
4818
+ prior runs. Requires: image,registry,name,code,enterprise,port
4819
+
4820
+ DESCRIPTION
4821
+ Creates a new asset in the given enterprise from an image that exists in a container registry.
4822
+
4823
+ ALIASES
4824
+ $ codiac asset new
4825
+ ```
4826
+
4827
+ ## `codiac asset destroy`
4828
+
4829
+ 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.
4830
+
4831
+ ```
4832
+ USAGE
4833
+ $ codiac asset destroy [-h] [-a <value>] [-v <value>] [-s] [-y]
4834
+
4835
+ FLAGS
4836
+ -a, --asset=<value> Search string for the name of the asset to destroy (use ? to be prompted).
4837
+ -h, --help Show CLI help.
4838
+ -s, --scorch (Optional: defaults to false) Destroys the service too, instead of just the deployment and
4839
+ pods.
4840
+ -v, --version=<value> Search string for the version of the asset to destroy (use ? to be prompted).
4841
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
4842
+ prior runs.
4843
+
4844
+ DESCRIPTION
4845
+ UN-deploys a given asset from a given cabinet. Defaults to removing only the pod deployments and leaving the service
4846
+ in place; set the --scorch argument to remove the service.
4847
+ ```
4848
+
4849
+ ## `codiac asset helm [SETTING]`
4850
+
4851
+ Creates a new asset in the given enterprise from an image that exists in a container registry.
4852
+
4853
+ ```
4854
+ USAGE
4855
+ $ codiac asset helm [SETTING] [-h] [-i <value>] [-y -r <value> -n <value> -c <value> -e <value> -p <value> -g
4856
+ -o]
4857
+
4858
+ ARGUMENTS
4859
+ SETTING The key for the config setting to add
4860
+
4861
+ FLAGS
4862
+ -c, --code=<value> The host name to assign this asset in the domain url. eg: 'myasset' in
4863
+ 'myasset.your-domain.com' (Optional: defaults to the asset name).
4864
+ -e, --enterprise=<value> The name of the enterprise in which to create this asset. (defaults to the current
4865
+ enterprise context)
4866
+ -g, --hasIngress Declaration that the asset service is to be externally accessible (optional: defaults to
4867
+ false).
4868
+ -h, --help Show CLI help.
4869
+ -i, --chart=<value> The chart name including scope prefix if applicable (eg: '@yourCompany/your-helm-chart').
4870
+ -n, --name=<value> The name to give the enterprise asset (Optional: defaults to the image name without the
4871
+ scope prefix).
4872
+ -o, --routedWithoutName Indicates that this asset will be the base ingress against your DNS. eg: true services
4873
+ yourwebsite.com (as root/naked) (optional: defaults to false).
4874
+ -p, --port=<value> The default port to assign the asset when deployed to a cabinet (optional).
4875
+ -r, --registry=<value> The chart registry in which the chart exists (defaults to docker hub).
4876
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
4877
+ prior runs. Requires: image,registry,name,code,enterprise,port,hasIngress,routedWithoutName
4878
+
4879
+ DESCRIPTION
4880
+ Creates a new asset in the given enterprise from an image that exists in a container registry.
4881
+
4882
+ ALIASES
4883
+ $ codiac asset new
4884
+ ```
4885
+
4886
+ ## `codiac asset new`
4887
+
4888
+ Creates a new asset in the given enterprise from an image that exists in a container registry.
4889
+
4890
+ ```
4891
+ USAGE
4892
+ $ codiac asset new [-h] [-k <value> | -i <value> | -r <value>] [-g] [-o] [-t] [-y -n <value> -c <value> -e
4893
+ <value> -p <value>]
4894
+
4895
+ FLAGS
4896
+ -c, --code=<value> The host name to assign this asset in the domain url. eg: 'myasset' in
4897
+ 'myasset.your-domain.com' (Optional: defaults to the asset name).
4898
+ -e, --enterprise=<value> The name of the enterprise in which to create this asset. (defaults to the current
4899
+ enterprise context)
4900
+ -g, --hasIngress Declaration that the asset service is to be externally accessible (optional: defaults to
4901
+ false).
4902
+ -h, --help Show CLI help.
4903
+ -i, --image=<value> The image name including scope prefix if applicable (eg: '@yourCompany/your-api-image').
4904
+ -k, --kit=<value> The name of the kit (with library prefix, eg: 'library/kitName') to use to create the asset.
4905
+ Use '?' to be prompted for a kit (Optional: used instead of calling for the image).
4906
+ -n, --name=<value> The name to give the enterprise asset (Optional: defaults to the image name without the
4907
+ scope prefix).
4908
+ -o, --routedWithoutName Indicates that this asset will be the base ingress against your DNS. eg: true services
4909
+ yourwebsite.com (as root/naked) (optional: defaults to false).
4910
+ -p, --port=<value> The default port to assign the asset when deployed to a cabinet (optional).
4911
+ -r, --registry=<value> The container registry in which the image exists (defaults to docker hub).
4912
+ -t, --toScript Outputs an assembled command string, NO execution
4913
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
4914
+ prior runs. Requires: image,registry,name,code,enterprise,port
4915
+
4916
+ DESCRIPTION
4917
+ Creates a new asset in the given enterprise from an image that exists in a container registry.
4918
+
4919
+ ALIASES
4920
+ $ codiac asset new
4921
+ ```
4922
+
4923
+ ## `codiac asset recycle`
4924
+
4925
+ Deploys a given asset to a given cabinet. Defaults to current version.
4926
+
4927
+ ```
4928
+ USAGE
4929
+ $ codiac asset recycle [-h] [-a <value>] [-v <value>] [-y -e <value> -c <value>]
4930
+
4931
+ FLAGS
4932
+ -a, --asset=<value> Search string for the name of the asset to deploy (use ? to be prompted).
4933
+ -c, --cabinetName=<value> Target cabinet name you want deploy
4934
+ -e, --enterpriseCode=<value> Code (name) of the enterprise to deploy
4935
+ -h, --help Show CLI help.
4936
+ -v, --version=<value> Search string for the version of the asset to deploy (use ? to be prompted).
4937
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered
4938
+ from prior runs. Requires: enterpriseCode,cabinetName
4939
+
4940
+ DESCRIPTION
4941
+ Deploys a given asset to a given cabinet. Defaults to current version.
4942
+ ```
4943
+
4944
+ ## `codiac asset vol add [MOUNTPATH]`
4945
+
4946
+ Declares a named path for mounting a volume to instances of the asset.
4947
+
4948
+ ```
4949
+ USAGE
4950
+ $ codiac asset vol add [MOUNTPATH] [-h] [-d <value>] [-y -n <value>]
4951
+
4952
+ ARGUMENTS
4953
+ MOUNTPATH Fully qualified mounting path, inside the container, of the folder being mapped as a volume. Must be
4954
+ unique for the asset.
4955
+
4956
+ FLAGS
4957
+ -d, --description=<value> Any notes or other information to help clarify the intended purpose of this folder, to
4958
+ assist during the configuration phase when assigning an actual physical file store to it.
4959
+ -h, --help Show CLI help.
4960
+ -n, --name=<value> Moniker for identifying, retrieving, and accessing this folder mapping. Must be unique for
4961
+ the asset.
4962
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered
4963
+ from prior runs. Requires: name
4964
+
4965
+ DESCRIPTION
4966
+ Declares a named path for mounting a volume to instances of the asset.
4967
+
4968
+ ALIASES
4969
+ $ codiac asset vol create
4970
+ $ codiac asset vol add
4971
+ $ codiac asset volume add
4972
+ ```
4973
+
4974
+ ## `codiac asset vol create [MOUNTPATH]`
4975
+
4976
+ Declares a named path for mounting a volume to instances of the asset.
4977
+
4978
+ ```
4979
+ USAGE
4980
+ $ codiac asset vol create [MOUNTPATH] [-h] [-d <value>] [-y -n <value>]
4981
+
4982
+ ARGUMENTS
4983
+ MOUNTPATH Fully qualified mounting path, inside the container, of the folder being mapped as a volume. Must be
4984
+ unique for the asset.
4985
+
4986
+ FLAGS
4987
+ -d, --description=<value> Any notes or other information to help clarify the intended purpose of this folder, to
4988
+ assist during the configuration phase when assigning an actual physical file store to it.
4989
+ -h, --help Show CLI help.
4990
+ -n, --name=<value> Moniker for identifying, retrieving, and accessing this folder mapping. Must be unique for
4991
+ the asset.
4992
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered
4993
+ from prior runs. Requires: name
4994
+
4995
+ DESCRIPTION
4996
+ Declares a named path for mounting a volume to instances of the asset.
4997
+
4998
+ ALIASES
4999
+ $ codiac asset vol create
5000
+ $ codiac asset vol add
5001
+ $ codiac asset volume add
5002
+ ```
5003
+
5004
+ ## `codiac asset vol del`
5005
+
5006
+ Deletes an existing volume mount in the asset
5007
+
5008
+ ```
5009
+ USAGE
5010
+ $ codiac asset vol del [-h] [-y -n <value>]
5011
+
5012
+ FLAGS
5013
+ -h, --help Show CLI help.
5014
+ -n, --name=<value> Moniker for identifying, retrieving, and accessing this folder mapping. Must be unique for the
5015
+ asset.
5016
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior
5017
+ runs. Requires: name
5018
+
5019
+ DESCRIPTION
5020
+ Deletes an existing volume mount in the asset
5021
+
5022
+ ALIASES
5023
+ $ codiac asset vol delete
5024
+ $ codiac asset volumes delete
5025
+ $ codiac asset volume del
5026
+ $ codiac asset vol del
5027
+ $ codiac asset volumes del
5028
+ ```
5029
+
5030
+ ## `codiac asset vol delete`
5031
+
5032
+ Deletes an existing volume mount in the asset
5033
+
5034
+ ```
5035
+ USAGE
5036
+ $ codiac asset vol delete [-h] [-y -n <value>]
5037
+
5038
+ FLAGS
5039
+ -h, --help Show CLI help.
5040
+ -n, --name=<value> Moniker for identifying, retrieving, and accessing this folder mapping. Must be unique for the
5041
+ asset.
5042
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior
5043
+ runs. Requires: name
5044
+
5045
+ DESCRIPTION
5046
+ Deletes an existing volume mount in the asset
5047
+
5048
+ ALIASES
5049
+ $ codiac asset vol delete
5050
+ $ codiac asset volumes delete
5051
+ $ codiac asset volume del
5052
+ $ codiac asset vol del
5053
+ $ codiac asset volumes del
5054
+ ```
5055
+
5056
+ ## `codiac asset volume add [MOUNTPATH]`
5057
+
5058
+ Declares a named path for mounting a volume to instances of the asset.
5059
+
5060
+ ```
5061
+ USAGE
5062
+ $ codiac asset volume add [MOUNTPATH] [-h] [-d <value>] [-y -n <value>]
5063
+
5064
+ ARGUMENTS
5065
+ MOUNTPATH Fully qualified mounting path, inside the container, of the folder being mapped as a volume. Must be
5066
+ unique for the asset.
5067
+
5068
+ FLAGS
5069
+ -d, --description=<value> Any notes or other information to help clarify the intended purpose of this folder, to
5070
+ assist during the configuration phase when assigning an actual physical file store to it.
5071
+ -h, --help Show CLI help.
5072
+ -n, --name=<value> Moniker for identifying, retrieving, and accessing this folder mapping. Must be unique for
5073
+ the asset.
5074
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered
5075
+ from prior runs. Requires: name
5076
+
5077
+ DESCRIPTION
5078
+ Declares a named path for mounting a volume to instances of the asset.
5079
+
5080
+ ALIASES
5081
+ $ codiac asset vol create
5082
+ $ codiac asset vol add
5083
+ $ codiac asset volume add
5084
+ ```
5085
+
5086
+ ## `codiac asset volume create [MOUNTPATH]`
5087
+
5088
+ Declares a named path for mounting a volume to instances of the asset.
5089
+
5090
+ ```
5091
+ USAGE
5092
+ $ codiac asset volume create [MOUNTPATH] [-h] [-d <value>] [-y -n <value>]
5093
+
5094
+ ARGUMENTS
5095
+ MOUNTPATH Fully qualified mounting path, inside the container, of the folder being mapped as a volume. Must be
5096
+ unique for the asset.
5097
+
5098
+ FLAGS
5099
+ -d, --description=<value> Any notes or other information to help clarify the intended purpose of this folder, to
5100
+ assist during the configuration phase when assigning an actual physical file store to it.
5101
+ -h, --help Show CLI help.
5102
+ -n, --name=<value> Moniker for identifying, retrieving, and accessing this folder mapping. Must be unique for
5103
+ the asset.
5104
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered
5105
+ from prior runs. Requires: name
5106
+
5107
+ DESCRIPTION
5108
+ Declares a named path for mounting a volume to instances of the asset.
5109
+
5110
+ ALIASES
5111
+ $ codiac asset vol create
5112
+ $ codiac asset vol add
5113
+ $ codiac asset volume add
5114
+ ```
5115
+
5116
+ ## `codiac asset volume del`
5117
+
5118
+ Deletes an existing volume mount in the asset
5119
+
5120
+ ```
5121
+ USAGE
5122
+ $ codiac asset volume del [-h] [-y -n <value>]
5123
+
5124
+ FLAGS
5125
+ -h, --help Show CLI help.
5126
+ -n, --name=<value> Moniker for identifying, retrieving, and accessing this folder mapping. Must be unique for the
5127
+ asset.
5128
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior
5129
+ runs. Requires: name
5130
+
5131
+ DESCRIPTION
5132
+ Deletes an existing volume mount in the asset
5133
+
5134
+ ALIASES
5135
+ $ codiac asset vol delete
5136
+ $ codiac asset volumes delete
5137
+ $ codiac asset volume del
5138
+ $ codiac asset vol del
5139
+ $ codiac asset volumes del
5140
+ ```
5141
+
5142
+ ## `codiac asset volume delete`
5143
+
5144
+ Deletes an existing volume mount in the asset
5145
+
5146
+ ```
5147
+ USAGE
5148
+ $ codiac asset volume delete [-h] [-y -n <value>]
5149
+
5150
+ FLAGS
5151
+ -h, --help Show CLI help.
5152
+ -n, --name=<value> Moniker for identifying, retrieving, and accessing this folder mapping. Must be unique for the
5153
+ asset.
5154
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior
5155
+ runs. Requires: name
5156
+
5157
+ DESCRIPTION
5158
+ Deletes an existing volume mount in the asset
5159
+
5160
+ ALIASES
5161
+ $ codiac asset vol delete
5162
+ $ codiac asset volumes delete
5163
+ $ codiac asset volume del
5164
+ $ codiac asset vol del
5165
+ $ codiac asset volumes del
5166
+ ```
5167
+
5168
+ ## `codiac asset volumes del`
5169
+
5170
+ Deletes an existing volume mount in the asset
5171
+
5172
+ ```
5173
+ USAGE
5174
+ $ codiac asset volumes del [-h] [-y -n <value>]
5175
+
5176
+ FLAGS
5177
+ -h, --help Show CLI help.
5178
+ -n, --name=<value> Moniker for identifying, retrieving, and accessing this folder mapping. Must be unique for the
5179
+ asset.
5180
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior
5181
+ runs. Requires: name
5182
+
5183
+ DESCRIPTION
5184
+ Deletes an existing volume mount in the asset
5185
+
5186
+ ALIASES
5187
+ $ codiac asset vol delete
5188
+ $ codiac asset volumes delete
5189
+ $ codiac asset volume del
5190
+ $ codiac asset vol del
5191
+ $ codiac asset volumes del
5192
+ ```
5193
+
5194
+ ## `codiac asset volumes delete`
5195
+
5196
+ Deletes an existing volume mount in the asset
5197
+
5198
+ ```
5199
+ USAGE
5200
+ $ codiac asset volumes delete [-h] [-y -n <value>]
5201
+
5202
+ FLAGS
5203
+ -h, --help Show CLI help.
5204
+ -n, --name=<value> Moniker for identifying, retrieving, and accessing this folder mapping. Must be unique for the
5205
+ asset.
5206
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior
5207
+ runs. Requires: name
5208
+
5209
+ DESCRIPTION
5210
+ Deletes an existing volume mount in the asset
5211
+
5212
+ ALIASES
5213
+ $ codiac asset vol delete
5214
+ $ codiac asset volumes delete
5215
+ $ codiac asset volume del
5216
+ $ codiac asset vol del
5217
+ $ codiac asset volumes del
5218
+ ```
5219
+
5220
+ ## `codiac autocomplete [SHELL]`
5221
+
5222
+ display autocomplete installation instructions
5223
+
5224
+ ```
5225
+ USAGE
5226
+ $ codiac autocomplete [SHELL] [-r]
5227
+
5228
+ ARGUMENTS
5229
+ SHELL shell type
5230
+
5231
+ FLAGS
5232
+ -r, --refresh-cache Refresh cache (ignores displaying instructions)
5233
+
5234
+ DESCRIPTION
5235
+ display autocomplete installation instructions
5236
+
5237
+ EXAMPLES
5238
+ $ codiac autocomplete
5239
+
5240
+ $ codiac autocomplete bash
5241
+
5242
+ $ codiac autocomplete zsh
5243
+
5244
+ $ codiac autocomplete --refresh-cache
5245
+ ```
5246
+
5247
+ _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.4.6/src/commands/autocomplete/index.ts)_
5248
+
5249
+ ## `codiac branch [NAME]`
5250
+
5251
+ Creates a new branch for the parent project and any sourced dependencies.
5252
+
5253
+ ```
5254
+ USAGE
5255
+ $ codiac branch [NAME] [-s] [-h]
5256
+
5257
+ ARGUMENTS
5258
+ NAME The name of the branch to create.
5259
+
5260
+ FLAGS
5261
+ -h, --help Show CLI help.
5262
+ -s, --switch Automatically switches to the new branch after creating it.
5263
+
5264
+ DESCRIPTION
5265
+ Creates a new branch for the parent project and any sourced dependencies.
5266
+ ```
5267
+
5268
+ _See code: [src/commands/branch.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/branch.ts)_
5269
+
5270
+ ## `codiac branch current`
5271
+
5272
+ Renders the name of the current branch (for the main project and for any sourced dependencies).
5273
+
5274
+ ```
5275
+ USAGE
5276
+ $ codiac branch current [-h]
5277
+
5278
+ FLAGS
5279
+ -h, --help Show CLI help.
5280
+
5281
+ DESCRIPTION
5282
+ Renders the name of the current branch (for the main project and for any sourced dependencies).
5283
+
5284
+ ALIASES
5285
+ $ codiac branches current
5286
+ ```
5287
+
5288
+ ## `codiac branch list`
5289
+
5290
+ Lists out existing branches for the project repo.
5291
+
5292
+ ```
5293
+ USAGE
5294
+ $ codiac branch list [-h] [-r | -l]
5295
+
5296
+ FLAGS
5297
+ -h, --help Displays the help document for this command.
5298
+ -l, --locals (Optional, defaults to false) Limits to local branches only.
5299
+ -r, --remotes (Optional, defaults to false) Limits to remote branches only.
5300
+
5301
+ DESCRIPTION
5302
+ Lists out existing branches for the project repo.
5303
+
5304
+ ALIASES
5305
+ $ codiac branches list
5306
+ ```
5307
+
5308
+ ## `codiac branches current`
5309
+
5310
+ Renders the name of the current branch (for the main project and for any sourced dependencies).
5311
+
5312
+ ```
5313
+ USAGE
5314
+ $ codiac branches current [-h]
5315
+
5316
+ FLAGS
5317
+ -h, --help Show CLI help.
5318
+
5319
+ DESCRIPTION
5320
+ Renders the name of the current branch (for the main project and for any sourced dependencies).
5321
+
5322
+ ALIASES
5323
+ $ codiac branches current
5324
+ ```
5325
+
5326
+ ## `codiac branches list`
5327
+
5328
+ Lists out existing branches for the project repo.
5329
+
5330
+ ```
5331
+ USAGE
5332
+ $ codiac branches list [-h] [-r | -l]
5333
+
5334
+ FLAGS
5335
+ -h, --help Displays the help document for this command.
5336
+ -l, --locals (Optional, defaults to false) Limits to local branches only.
5337
+ -r, --remotes (Optional, defaults to false) Limits to remote branches only.
5338
+
5339
+ DESCRIPTION
5340
+ Lists out existing branches for the project repo.
5341
+
5342
+ ALIASES
5343
+ $ codiac branches list
5344
+ ```
5345
+
5346
+ ## `codiac cab create [CABINET]`
5347
+
5348
+ Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.
5349
+
5350
+ ```
5351
+ USAGE
5352
+ $ codiac cab create [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
5353
+ [--withoutdefaults] [-v] [-h] [-f] [-e <value>]
5354
+
5355
+ ARGUMENTS
5356
+ CABINET The name of the cabinet to create
5357
+
5358
+ FLAGS
5359
+ -e, --environment=<value> (optional: defaults to that of the current project branch) The name of the environment this
5360
+ cabinet will be grouped under.
5361
+ -f, --force Overwrites and reinitializes if the cabinet already exists.
5362
+ -h, --help Show CLI help.
5363
+ -v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
5364
+ --as=<value> Fires this command with an argument list that was previously remembered using the
5365
+ --rememberAs flag.
5366
+ --remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
5367
+ --rememberAs=<value> Saves the given argument list so that it can be called by name.
5368
+ --unremember=<value> Administrative only: DOES NOT fire the actual command. Simply clears the arguments that
5369
+ were previously stored under the given name (use "--unRemember default" to clear default
5370
+ argument list memorized with the --remember flag).
5371
+ --withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
5372
+
5373
+ DESCRIPTION
5374
+ Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an
5375
+ error if the cabinet already exists.
5376
+
5377
+ ALIASES
5378
+ $ codiac cab create
5379
+ ```
5380
+
5381
+ ## `codiac cab obliterate [CABINET]`
5382
+
5383
+ Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.
5384
+
5385
+ ```
5386
+ USAGE
5387
+ $ codiac cab obliterate [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
5388
+ [--withoutdefaults] [-v] [-h] [-e <value>]
5389
+
5390
+ ARGUMENTS
5391
+ CABINET The name of the cabinet
5392
+
5393
+ FLAGS
5394
+ -e, --environment=<value> (optional: defaults to that of the current project branch) The name of the environment this
5395
+ cabinet will be grouped under.
5396
+ -h, --help Show CLI help.
5397
+ -v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
5398
+ --as=<value> Fires this command with an argument list that was previously remembered using the
5399
+ --rememberAs flag.
5400
+ --remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
5401
+ --rememberAs=<value> Saves the given argument list so that it can be called by name.
5402
+ --unremember=<value> Administrative only: DOES NOT fire the actual command. Simply clears the arguments that
5403
+ were previously stored under the given name (use "--unRemember default" to clear default
5404
+ argument list memorized with the --remember flag).
5405
+ --withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
5406
+
5407
+ DESCRIPTION
5408
+ Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.
5409
+
5410
+ ALIASES
5411
+ $ codiac cab obliterate
5412
+ ```
5413
+
5414
+ ## `codiac cabinet create [CABINET]`
5415
+
5416
+ Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.
5417
+
5418
+ ```
5419
+ USAGE
5420
+ $ codiac cabinet create [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
5421
+ [--withoutdefaults] [-v] [-h] [-f] [-e <value>]
5422
+
5423
+ ARGUMENTS
5424
+ CABINET The name of the cabinet to create
5425
+
5426
+ FLAGS
5427
+ -e, --environment=<value> (optional: defaults to that of the current project branch) The name of the environment this
5428
+ cabinet will be grouped under.
5429
+ -f, --force Overwrites and reinitializes if the cabinet already exists.
5430
+ -h, --help Show CLI help.
5431
+ -v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
5432
+ --as=<value> Fires this command with an argument list that was previously remembered using the
5433
+ --rememberAs flag.
5434
+ --remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
5435
+ --rememberAs=<value> Saves the given argument list so that it can be called by name.
5436
+ --unremember=<value> Administrative only: DOES NOT fire the actual command. Simply clears the arguments that
5437
+ were previously stored under the given name (use "--unRemember default" to clear default
5438
+ argument list memorized with the --remember flag).
5439
+ --withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
5440
+
5441
+ DESCRIPTION
5442
+ Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an
5443
+ error if the cabinet already exists.
5444
+
5445
+ ALIASES
5446
+ $ codiac cab create
5447
+ ```
5448
+
5449
+ ## `codiac cabinet obliterate [CABINET]`
5450
+
5451
+ Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.
5452
+
5453
+ ```
5454
+ USAGE
5455
+ $ codiac cabinet obliterate [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
5456
+ [--withoutdefaults] [-v] [-h] [-e <value>]
5457
+
5458
+ ARGUMENTS
5459
+ CABINET The name of the cabinet
5460
+
5461
+ FLAGS
5462
+ -e, --environment=<value> (optional: defaults to that of the current project branch) The name of the environment this
5463
+ cabinet will be grouped under.
5464
+ -h, --help Show CLI help.
5465
+ -v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
5466
+ --as=<value> Fires this command with an argument list that was previously remembered using the
5467
+ --rememberAs flag.
5468
+ --remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
5469
+ --rememberAs=<value> Saves the given argument list so that it can be called by name.
5470
+ --unremember=<value> Administrative only: DOES NOT fire the actual command. Simply clears the arguments that
5471
+ were previously stored under the given name (use "--unRemember default" to clear default
5472
+ argument list memorized with the --remember flag).
5473
+ --withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
5474
+
5475
+ DESCRIPTION
5476
+ Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.
5477
+
5478
+ ALIASES
5479
+ $ codiac cab obliterate
5480
+ ```
5481
+
5482
+ ## `codiac cfg add [SETTING]`
5483
+
5484
+ Adds a key value pair to the app config
5485
+
5486
+ ```
5487
+ USAGE
5488
+ $ codiac cfg add [SETTING] [-h] [-s <value>] [-v <value>] [-n <value> | -e <value> | -c <value>] [-f
5489
+ <value>]
5490
+
5491
+ ARGUMENTS
5492
+ SETTING The key for the config setting to add
5493
+
5494
+ FLAGS
5495
+ -c, --cabinet=<value> The name of the cabinet to which this value is to apply.
5496
+ -e, --environment=<value> The name of the environment to which this value is to apply.
5497
+ -f, --file=<value> The path-name to the file to which the settings are written, relative to the root of the
5498
+ Codiac project.
5499
+ -h, --help Show CLI help.
5500
+ -n, --enterprise=<value> The name of the enterprise to which this value is to apply.
5501
+ -s, --setting=<value> The config key (in dotpath/JSONPath), relative to the root of the config.
5502
+ -v, --value=<value> The actual concrete data to be applied as the setting value.
5503
+
5504
+ DESCRIPTION
5505
+ Adds a key value pair to the app config
5506
+
5507
+ ALIASES
5508
+ $ codiac config set
5509
+ $ codiac cfg add
5510
+ ```
5511
+
5512
+ ## `codiac cfg delete [SETTING]`
5513
+
5514
+ Removes the given keys from the app config
5515
+
5516
+ ```
5517
+ USAGE
5518
+ $ codiac cfg delete [SETTING] [-h] [-s <value>] [-n <value> | -e <value> | -c <value>] [-f <value>]
5519
+
5520
+ ARGUMENTS
5521
+ SETTING (optional) Specific config key to remove. Omit to select from a list. Enter "all" to clear the entire config.
5522
+
5523
+ FLAGS
5524
+ -c, --cabinet=<value> The name of the cabinet to which this value is to apply.
5525
+ -e, --environment=<value> The name of the environment to which this value is to apply.
5526
+ -f, --file=<value> The path-name to the config file holding the settings, relative to the root of the Codiac
5527
+ project.
5528
+ -h, --help Show CLI help.
5529
+ -n, --enterprise=<value> The name of the enterprise to which this value is to apply.
5530
+ -s, --setting=<value> The config key (in dotpath/JSONPath), relative to the root of the config.
5531
+
5532
+ DESCRIPTION
5533
+ Removes the given keys from the app config
5534
+
5535
+ ALIASES
5536
+ $ codiac cfg delete
5537
+ ```
5538
+
5539
+ ## `codiac cli`
5540
+
5541
+ Applies settings to the Codiac CLI itself (scoped to the local machine).
5542
+
5543
+ ```
5544
+ USAGE
5545
+ $ codiac cli [-h] [-s <value>]
5546
+
5547
+ FLAGS
5548
+ -h, --help Show the help docs for this command.
5549
+ -s, --set=<value>... A key=value expression for the setting to apply. Leave this argument out of your call to get a
5550
+ list of the available settings keys and their types.
5551
+
5552
+ DESCRIPTION
5553
+ Applies settings to the Codiac CLI itself (scoped to the local machine).
5554
+ ```
5555
+
5556
+ _See code: [src/commands/cli.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/cli.ts)_
5557
+
5558
+ ## `codiac cluster create [NAME]`
5559
+
5560
+ Provisions the physical cluster
5561
+
5562
+ ```
5563
+ USAGE
5564
+ $ codiac cluster create [NAME] [-h] [-p <value>] [-k <value>] [-u <value>] [-u <value>] [-y <value> -s <value> -g
5565
+ <value> -l <value> -n <value> -q <value>] [-t]
5566
+
5567
+ ARGUMENTS
5568
+ NAME Proposed name of the cluster
5569
+
5570
+ FLAGS
5571
+ -g, --resourceGroup=<value> The Azure resource group to create for the cluster.
5572
+ -h, --help Show CLI help.
5573
+ -k, --subnet=<value> The resource id of the subnet in which the cluster is to be created.
5574
+ -l, --location=<value> The short name of the azure data center in which the cliuster is to reside.
5575
+ -n, --nodeSpec=<value> The identifier for the type of VM to use for nodes in the cluster.
5576
+ -p, --owner=<value> Tenant code of the private owner of the cluster
5577
+ -q, --nodeQty=<value> The starting node count with which to create the cluster.
5578
+ -s, --providerSubscription=<value> The Azure subscription Id under which to create the cluster.
5579
+ -t, --toScript Outputs an assembled command string, NO execution
5580
+ -u, --identityUserId=<value> OPTIONAL. ID of Svc Principal or Managed Identity to execute as. To create k8s
5581
+ cluster, IP address, and container Pull. If none supplied Codiac will try to
5582
+ create one.
5583
+ -u, --identityUserName=<value> OPTIONAL. Name of Svc Principal or Managed Identity to execute as. To create k8s
5584
+ cluster, IP address, and container Pull. If none supplied Codiac will try to
5585
+ create one.
5586
+ -y, --silent=<value> (Optional: defaults to false) Prevents confirmations of user-values. Required:
5587
+ providerSubscription,resourceGroup,location,nodeSpec,nodeQty
5588
+
5589
+ DESCRIPTION
5590
+ Provisions the physical cluster
5591
+
5592
+ ALIASES
5593
+ $ codiac cluster create
5594
+ ```
5595
+
5596
+ ## `codiac commit [MESSAGE]`
5597
+
5598
+ Commits the currently staged changes on the current branch of the main project and on any sourced dependencies.
5599
+
5600
+ ```
5601
+ USAGE
5602
+ $ codiac commit [MESSAGE] [-h]
5603
+
5604
+ ARGUMENTS
5605
+ MESSAGE The description to include in this particular commit.
5606
+
5607
+ FLAGS
5608
+ -h, --help Show CLI help.
5609
+
5610
+ DESCRIPTION
5611
+ Commits the currently staged changes on the current branch of the main project and on any sourced dependencies.
5612
+ ```
5613
+
5614
+ _See code: [src/commands/commit.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/commit.ts)_
5615
+
5616
+ ## `codiac config add [SETTING]`
5617
+
5618
+ Adds a key value pair to the app config
5619
+
5620
+ ```
5621
+ USAGE
5622
+ $ codiac config add [SETTING] [-h] [-s <value>] [-v <value>] [-n <value> | -e <value> | -c <value>] [-f
5623
+ <value>]
5624
+
5625
+ ARGUMENTS
5626
+ SETTING The key for the config setting to add
5627
+
5628
+ FLAGS
5629
+ -c, --cabinet=<value> The name of the cabinet to which this value is to apply.
5630
+ -e, --environment=<value> The name of the environment to which this value is to apply.
5631
+ -f, --file=<value> The path-name to the file to which the settings are written, relative to the root of the
5632
+ Codiac project.
5633
+ -h, --help Show CLI help.
5634
+ -n, --enterprise=<value> The name of the enterprise to which this value is to apply.
5635
+ -s, --setting=<value> The config key (in dotpath/JSONPath), relative to the root of the config.
5636
+ -v, --value=<value> The actual concrete data to be applied as the setting value.
5637
+
5638
+ DESCRIPTION
5639
+ Adds a key value pair to the app config
5640
+
5641
+ ALIASES
5642
+ $ codiac config set
5643
+ $ codiac cfg add
5644
+ ```
5645
+
5646
+ ## `codiac config delete [SETTING]`
5647
+
5648
+ Removes the given keys from the app config
5649
+
5650
+ ```
5651
+ USAGE
5652
+ $ codiac config delete [SETTING] [-h] [-s <value>] [-n <value> | -e <value> | -c <value>] [-f <value>]
5653
+
5654
+ ARGUMENTS
5655
+ SETTING (optional) Specific config key to remove. Omit to select from a list. Enter "all" to clear the entire config.
5656
+
5657
+ FLAGS
5658
+ -c, --cabinet=<value> The name of the cabinet to which this value is to apply.
5659
+ -e, --environment=<value> The name of the environment to which this value is to apply.
5660
+ -f, --file=<value> The path-name to the config file holding the settings, relative to the root of the Codiac
5661
+ project.
5662
+ -h, --help Show CLI help.
5663
+ -n, --enterprise=<value> The name of the enterprise to which this value is to apply.
5664
+ -s, --setting=<value> The config key (in dotpath/JSONPath), relative to the root of the config.
5665
+
5666
+ DESCRIPTION
5667
+ Removes the given keys from the app config
5668
+
5669
+ ALIASES
5670
+ $ codiac cfg delete
5671
+ ```
5672
+
5673
+ ## `codiac config deploy`
5674
+
5675
+ Deploys a given asset to a given cabinet. Defaults to current version.
5676
+
5677
+ ```
5678
+ USAGE
5679
+ $ codiac config deploy [-h] [-a <value>] [-v <value>] [-y -e <value> -c <value>]
5680
+
5681
+ FLAGS
5682
+ -a, --asset=<value> Search string for the name of the asset to deploy (use ? to be prompted).
5683
+ -c, --cabinetName=<value> Target cabinet name you want deploy
5684
+ -e, --enterpriseCode=<value> Code (name) of the enterprise to deploy
5685
+ -h, --help Show CLI help.
5686
+ -v, --version=<value> Search string for the version of the asset to deploy (use ? to be prompted).
5687
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered
5688
+ from prior runs. Requires: enterpriseCode,cabinetName
5689
+
5690
+ DESCRIPTION
5691
+ Deploys a given asset to a given cabinet. Defaults to current version.
5692
+ ```
5693
+
5694
+ ## `codiac config import [SETTING]`
5695
+
5696
+ Adds a key value pair to the app config
5697
+
5698
+ ```
5699
+ USAGE
5700
+ $ codiac config import [SETTING] [-h] [-n <value> | -e <value> | -c <value>] [-s <value>] [-f <value>]
5701
+
5702
+ ARGUMENTS
5703
+ SETTING The key for the config setting to add
5704
+
5705
+ FLAGS
5706
+ -c, --cabinet=<value> The name of the cabinet to which this value is to apply.
5707
+ -e, --environment=<value> The name of the environment to which this value is to apply.
5708
+ -f, --runtimePathName=<value> (optional, uses the original filename) The pathname relative to the app root to assume
5709
+ in the container.
5710
+ -h, --help Show CLI help.
5711
+ -n, --enterprise=<value> The name of the enterprise to which this value is to apply.
5712
+ -s, --sourceFile=<value> The path-name to the LOCAL file to which the settings are written, relative to the root
5713
+ of the Codiac project.
5714
+
5715
+ DESCRIPTION
5716
+ Adds a key value pair to the app config
5717
+
5718
+ ALIASES
5719
+ $ codiac cfg add
5720
+ ```
5721
+
5722
+ ## `codiac config set [SETTING]`
5723
+
5724
+ Adds a key value pair to the app config
5725
+
5726
+ ```
5727
+ USAGE
5728
+ $ codiac config set [SETTING] [-h] [-s <value>] [-v <value>] [-n <value> | -e <value> | -c <value>] [-f
5729
+ <value>]
5730
+
5731
+ ARGUMENTS
5732
+ SETTING The key for the config setting to add
5733
+
5734
+ FLAGS
5735
+ -c, --cabinet=<value> The name of the cabinet to which this value is to apply.
5736
+ -e, --environment=<value> The name of the environment to which this value is to apply.
5737
+ -f, --file=<value> The path-name to the file to which the settings are written, relative to the root of the
5738
+ Codiac project.
5739
+ -h, --help Show CLI help.
5740
+ -n, --enterprise=<value> The name of the enterprise to which this value is to apply.
5741
+ -s, --setting=<value> The config key (in dotpath/JSONPath), relative to the root of the config.
5742
+ -v, --value=<value> The actual concrete data to be applied as the setting value.
5743
+
5744
+ DESCRIPTION
5745
+ Adds a key value pair to the app config
5746
+
5747
+ ALIASES
5748
+ $ codiac config set
5749
+ $ codiac cfg add
5750
+ ```
5751
+
5752
+ ## `codiac csp login [PROVIDER]`
5753
+
5754
+ Authenticates with the given Cloud Service Provider (CSP), eg: aws, azure, docker. Use this command both to validate credentials and to declare the csp user account for subsequent commands involving that provider.
5755
+
5756
+ ```
5757
+ USAGE
5758
+ $ codiac csp login [PROVIDER] [-u <value> | --clientSecret] [-p <value> | ] [-y]
5759
+
5760
+ ARGUMENTS
5761
+ PROVIDER (aws|azure|dockerHub|other) Code indicating the Cloud Service Provider (CSP) being authenticated with.
5762
+
5763
+ FLAGS
5764
+ -p, --password=<value> (must be provided via stdin) The password at the given cloud provider.
5765
+ -u, --user=<value> The username at the given cloud provider.
5766
+ -y, --silent (Optional: defaults to false) Suppresses any user-interaction.
5767
+ --clientSecret (must be provided interactively or via stdin) Invokes the OAuth Client Credentials Flow. Used
5768
+ to authenticate when no user is present, such as an internal service or in a devops pipeline.
5769
+ Note: This is a secret that must be created when Codiac gets registered as a trusted
5770
+ application in your cloud service provider subscription (eg: in azure, this is an app
5771
+ registration in Azure AD).
5772
+
5773
+ DESCRIPTION
5774
+ Authenticates with the given Cloud Service Provider (CSP), eg: aws, azure, docker. Use this command both to validate
5775
+ credentials and to declare the csp user account for subsequent commands involving that provider.
5776
+
5777
+ EXAMPLES
5778
+ cod csp login
5779
+
5780
+ cod csp login docker
5781
+
5782
+ cat mypassword.txt | cod csp login -u me@mydomain.com --silent docker
5783
+
5784
+ cat theclientsecret.txt | cod csp login --clientSecret --silent azure
5785
+ ```
5786
+
5787
+ ## `codiac csp logout [PROVIDER]`
5788
+
5789
+ Closes session with the given Cloud Service Provider (CSP), eg: aws, azure, docker. Use this command to clear the local cache for your security account at that provider.
5790
+
5791
+ ```
5792
+ USAGE
5793
+ $ codiac csp logout [PROVIDER] [-y]
5794
+
5795
+ ARGUMENTS
5796
+ PROVIDER (aws|azure|dockerHub|other) Code indicating the Cloud Service Provider (CSP) being authenticated with.
5797
+
5798
+ FLAGS
5799
+ -y, --silent (Optional: defaults to false) Suppresses any user-interaction.
5800
+
5801
+ DESCRIPTION
5802
+ Closes session with the given Cloud Service Provider (CSP), eg: aws, azure, docker. Use this command to clear the
5803
+ local cache for your security account at that provider.
5804
+
5805
+ EXAMPLES
5806
+ cod csp logout
5807
+
5808
+ cod csp logout docker
5809
+
5810
+ cod csp logout --silent azure
5811
+ ```
5812
+
5813
+ ## `codiac dash`
5814
+
5815
+ Spins up the dashboard for a given cabinet
5816
+
5817
+ ```
5818
+ USAGE
5819
+ $ codiac dash [-h]
5820
+
5821
+ FLAGS
5822
+ -h, --help Show CLI help.
5823
+
5824
+ DESCRIPTION
5825
+ Spins up the dashboard for a given cabinet
5826
+
5827
+ ALIASES
5828
+ $ codiac view dash
5829
+ $ codiac dash
5830
+ ```
5831
+
5832
+ ## `codiac dep [NAME]`
5833
+
5834
+ Installs a package into current project.
5835
+
5836
+ ```
5837
+ USAGE
5838
+ $ codiac dep [NAME] [-h] [-v <value>]
5839
+
5840
+ ARGUMENTS
5841
+ NAME The official unique name of the package to install.
5842
+
5843
+ FLAGS
5844
+ -h, --help Show CLI help.
5845
+ -v, --version=<value> version of the package to install
5846
+
5847
+ DESCRIPTION
5848
+ Installs a package into current project.
5849
+ ```
5850
+
5851
+ _See code: [src/commands/dep.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/dep.ts)_
5852
+
5853
+ ## `codiac dep create [URL]`
5854
+
5855
+ 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.
5856
+
5857
+ ```
5858
+ USAGE
5859
+ $ codiac dep create [URL] -n <value> [-h] [-v <value>]
5860
+
5861
+ ARGUMENTS
5862
+ URL The official clone url for the repository.
5863
+
5864
+ FLAGS
5865
+ -h, --help Show CLI help.
5866
+ -n, --pkgName=<value> (required) Package name including any scope prefix (eg: @codiac.io/)
5867
+ -v, --version=<value> Version to apply to the dependency package if it has not yet been initialized.
5868
+
5869
+ DESCRIPTION
5870
+ Sources a new dependency into the project from an existing repo url, initializes it with the package repository, and
5871
+ publishes the initial version if it is not already. If the package repository is already initialized, the latest
5872
+ package version is used.
5873
+ ```
5874
+
5875
+ ## `codiac dep install`
5876
+
5877
+ installs any missing dependency packages into the local project folder.
5878
+
5879
+ ```
5880
+ USAGE
5881
+ $ codiac dep install [-h]
5882
+
5883
+ FLAGS
5884
+ -h, --help Show CLI help.
5885
+
5886
+ DESCRIPTION
5887
+ installs any missing dependency packages into the local project folder.
5888
+ ```
5889
+
5890
+ ## `codiac dep list`
5891
+
5892
+ Shows the dependencies for the project.
5893
+
5894
+ ```
5895
+ USAGE
5896
+ $ codiac dep list [-h]
5897
+
5898
+ FLAGS
5899
+ -h, --help Show CLI help.
5900
+
5901
+ DESCRIPTION
5902
+ Shows the dependencies for the project.
5903
+ ```
5904
+
5905
+ ## `codiac dep remove [NAME]`
5906
+
5907
+ Removes a dependency from the project.
5908
+
5909
+ ```
5910
+ USAGE
5911
+ $ codiac dep remove [NAME] [-h] [-d]
5912
+
5913
+ ARGUMENTS
5914
+ NAME The official unique name of the dependency package.
5915
+
5916
+ FLAGS
5917
+ -d, --discard If the dependency to remove is sourced into the project, setting this flag discards all uncommitted
5918
+ changes (staged and unstaged) before removing it. Again, uncomitted changes are LOST when this flag is
5919
+ set.
5920
+ -h, --help Show CLI help.
5921
+
5922
+ DESCRIPTION
5923
+ Removes a dependency from the project.
5924
+ ```
5925
+
5926
+ ## `codiac dep source [NAME]`
5927
+
5928
+ Loads the source code for the given dependency
5929
+
5930
+ ```
5931
+ USAGE
5932
+ $ codiac dep source [NAME] [-h] [-d <value>]
5933
+
5934
+ ARGUMENTS
5935
+ NAME The official unique name of the dependency package.
5936
+
5937
+ FLAGS
5938
+ -d, --distSubPath=<value> Subfolder path, relative to the root of the submodule, to the folder from which the
5939
+ package is created, aka: the build output folder or 'dist' folder (eg: bin, dist, or lib,
5940
+ ...etc). This folder is used as the target folder for npm link.
5941
+ -h, --help Show CLI help.
5942
+
5943
+ DESCRIPTION
5944
+ Loads the source code for the given dependency
5945
+
5946
+ ALIASES
5947
+ $ codiac dep src
5948
+ ```
5949
+
5950
+ ## `codiac dep src [NAME]`
5951
+
5952
+ Loads the source code for the given dependency
5953
+
5954
+ ```
5955
+ USAGE
5956
+ $ codiac dep src [NAME] [-h] [-d <value>]
5957
+
5958
+ ARGUMENTS
5959
+ NAME The official unique name of the dependency package.
5960
+
5961
+ FLAGS
5962
+ -d, --distSubPath=<value> Subfolder path, relative to the root of the submodule, to the folder from which the
5963
+ package is created, aka: the build output folder or 'dist' folder (eg: bin, dist, or lib,
5964
+ ...etc). This folder is used as the target folder for npm link.
5965
+ -h, --help Show CLI help.
5966
+
5967
+ DESCRIPTION
5968
+ Loads the source code for the given dependency
5969
+
5970
+ ALIASES
5971
+ $ codiac dep src
5972
+ ```
5973
+
5974
+ ## `codiac dep syncup [DEPENDENCY]`
5975
+
5976
+ Publishes the dependency in its current state and upgrades to it in the main project.
5977
+
5978
+ ```
5979
+ USAGE
5980
+ $ codiac dep syncup [DEPENDENCY] [-h]
5981
+
5982
+ ARGUMENTS
5983
+ DEPENDENCY The package name of the dependency to sync up into the main project
5984
+
5985
+ FLAGS
5986
+ -h, --help Show CLI help.
5987
+
5988
+ DESCRIPTION
5989
+ Publishes the dependency in its current state and upgrades to it in the main project.
5990
+ ```
5991
+
5992
+ ## `codiac dep unsource [NAME]`
5993
+
5994
+ 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.
5995
+
5996
+ ```
5997
+ USAGE
5998
+ $ codiac dep unsource [NAME] [-h] [-d] [-c]
5999
+
6000
+ ARGUMENTS
6001
+ NAME The official unique name of the dependency package.
6002
+
6003
+ FLAGS
6004
+ -c, --comment The commit message for any outstanding changes.
6005
+ -d, --discard Discards all uncommitted changes (staged and unstaged) before unsourcing, and goes back to the
6006
+ previously installed version of the dependency. Again, uncomitted changes are LOST when this flag is
6007
+ set.
6008
+ -h, --help Show CLI help.
6009
+
6010
+ DESCRIPTION
6011
+ Exits source mode for the given dependency by physically removing its source code folder from the project, and points
6012
+ the project dependency back to the package version it previously depended on.
6013
+
6014
+ ALIASES
6015
+ $ codiac dep unsrc
6016
+ ```
6017
+
6018
+ ## `codiac dep unsrc [NAME]`
6019
+
6020
+ 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.
6021
+
6022
+ ```
6023
+ USAGE
6024
+ $ codiac dep unsrc [NAME] [-h] [-d] [-c]
6025
+
6026
+ ARGUMENTS
6027
+ NAME The official unique name of the dependency package.
6028
+
6029
+ FLAGS
6030
+ -c, --comment The commit message for any outstanding changes.
6031
+ -d, --discard Discards all uncommitted changes (staged and unstaged) before unsourcing, and goes back to the
6032
+ previously installed version of the dependency. Again, uncomitted changes are LOST when this flag is
6033
+ set.
6034
+ -h, --help Show CLI help.
6035
+
6036
+ DESCRIPTION
6037
+ Exits source mode for the given dependency by physically removing its source code folder from the project, and points
6038
+ the project dependency back to the package version it previously depended on.
6039
+
6040
+ ALIASES
6041
+ $ codiac dep unsrc
6042
+ ```
6043
+
6044
+ ## `codiac dep upgrade [DEPENDENCY]`
6045
+
6046
+ describe the command here
6047
+
6048
+ ```
6049
+ USAGE
6050
+ $ codiac dep upgrade [DEPENDENCY] [-h] [-v <value>]
6051
+
6052
+ ARGUMENTS
6053
+ DEPENDENCY The dependency to upgrade
6054
+
6055
+ FLAGS
6056
+ -h, --help Show CLI help.
6057
+ -v, --version=<value> version of the package to install
6058
+
6059
+ DESCRIPTION
6060
+ describe the command here
6061
+ ```
6062
+
6063
+ ## `codiac deploy`
6064
+
6065
+ Deploys a given asset to a given cabinet. Defaults to current version.
6066
+
6067
+ ```
6068
+ USAGE
6069
+ $ codiac deploy [-h] [-a <value>] [-u <value>] [-n <value>] [-p <value>] [-y -e <value> -c <value>]
6070
+
6071
+ FLAGS
6072
+ -a, --asset=<value> Search string for the name of the asset to deploy (use ? or ?? to be prompted).
6073
+ -c, --cabinetName=<value> Target cabinet name you want deploy
6074
+ -e, --enterpriseCode=<value> Code (name) of the enterprise to deploy
6075
+ -h, --help Show CLI help.
6076
+ -n, --providerUserName=<value> OPTIONAL: For silent/scripted calls, bring cloud creds to auth against
6077
+ -p, --providerPassword=<value> OPTIONAL: For silent/scripted calls, bring cloud creds to auth against
6078
+ -u, --version=<value> Search string for the version of the asset to deploy (use ? or ?? to be prompted).
6079
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are
6080
+ remembered from prior runs. Requires: enterpriseCode,cabinetName
6081
+
6082
+ DESCRIPTION
6083
+ Deploys a given asset to a given cabinet. Defaults to current version.
6084
+ ```
6085
+
6086
+ _See code: [src/commands/deploy.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/deploy.ts)_
6087
+
6088
+ ## `codiac domain map [DOMAIN]`
6089
+
6090
+ Declares a strategy for mapping assets to ingress routes for a domain name.
6091
+
6092
+ ```
6093
+ USAGE
6094
+ $ codiac domain map [DOMAIN] [-h] [-n <value>] [-e <value> | -v <value>] [-c <value> | ] [-x]
6095
+
6096
+ ARGUMENTS
6097
+ DOMAIN The domain name to route (eg: "my-company.com")
6098
+
6099
+ FLAGS
6100
+ -c, --cabinet=<value> The name of the cabinet on which to apply this naming strategy. Must be qualified by also
6101
+ setting enterprise. NOTE: You can leave this blank if there is only one. If cabinet names
6102
+ are not unique, use the --enterprise/-e argument to fully qualify the cabinet name.
6103
+ -e, --enterprise=<value> The name of the enterprise on which to apply this naming strategy. NOTE: You can leave this
6104
+ blank if there is only one.
6105
+ -h, --help Show CLI help.
6106
+ -n, --naming=<value> The host naming strategy to apply.
6107
+ -v, --environment=<value> The name of the environment on which to apply this naming strategy. Must be qualified by
6108
+ also setting enterprise. NOTE: You can leave this blank if there is only one.
6109
+ -x, --noninteractive Throws errors if user interaction is required.
6110
+
6111
+ DESCRIPTION
6112
+ Declares a strategy for mapping assets to ingress routes for a domain name.
6113
+
6114
+ ALIASES
6115
+ $ codiac domain map
6116
+ ```
6117
+
6118
+ ## `codiac enterprise create [CODE]`
6119
+
6120
+ Creates a new enterprise under the current tenant.
6121
+
6122
+ ```
6123
+ USAGE
6124
+ $ codiac enterprise create [CODE] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
6125
+ [--withoutdefaults] [-v] [-h]
6126
+
6127
+ ARGUMENTS
6128
+ CODE The unique human-readable identitifer to use for the enterprise (must be alphanunmeric with no spaces).
6129
+
6130
+ FLAGS
6131
+ -h, --help Show CLI help.
6132
+ -v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
6133
+ --as=<value> Fires this command with an argument list that was previously remembered using the --rememberAs
6134
+ flag.
6135
+ --remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
6136
+ --rememberAs=<value> Saves the given argument list so that it can be called by name.
6137
+ --unremember=<value> Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
6138
+ previously stored under the given name (use "--unRemember default" to clear default argument
6139
+ list memorized with the --remember flag).
6140
+ --withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
6141
+
6142
+ DESCRIPTION
6143
+ Creates a new enterprise under the current tenant.
6144
+ ```
6145
+
6146
+ ## `codiac env add [SETTING]`
6147
+
6148
+ Adds a key value pair to the app config
6149
+
6150
+ ```
6151
+ USAGE
6152
+ $ codiac env add [SETTING] [-h] [-s <value>] [-v <value>] [-n <value> | -e <value> | -c <value>]
6153
+
6154
+ ARGUMENTS
6155
+ SETTING The name of the environment variable to add
6156
+
6157
+ FLAGS
6158
+ -c, --cabinet=<value> The name of the cabinet to which this value is to apply.
6159
+ -e, --environment=<value> The name of the environment to which this value is to apply.
6160
+ -h, --help Show CLI help.
6161
+ -n, --enterprise=<value> The name of the enterprise to which this value is to apply.
6162
+ -s, --setting=<value> The name of the environment variable to add.
6163
+ -v, --value=<value> The actual concrete data to be applied as the setting value.
6164
+
6165
+ DESCRIPTION
6166
+ Adds a key value pair to the app config
6167
+ ```
6168
+
6169
+ ## `codiac enviro create [NAME]`
6170
+
6171
+ Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.
6172
+
6173
+ ```
6174
+ USAGE
6175
+ $ codiac enviro create [NAME] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
6176
+ [--withoutdefaults] [-v] [-h]
6177
+
6178
+ ARGUMENTS
6179
+ NAME The name of the environment to create
6180
+
6181
+ FLAGS
6182
+ -h, --help Show CLI help.
6183
+ -v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
6184
+ --as=<value> Fires this command with an argument list that was previously remembered using the --rememberAs
6185
+ flag.
6186
+ --remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
6187
+ --rememberAs=<value> Saves the given argument list so that it can be called by name.
6188
+ --unremember=<value> Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
6189
+ previously stored under the given name (use "--unRemember default" to clear default argument
6190
+ list memorized with the --remember flag).
6191
+ --withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
6192
+
6193
+ DESCRIPTION
6194
+ Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an
6195
+ error if the cabinet already exists.
6196
+
6197
+ ALIASES
6198
+ $ codiac enviro create
6199
+ ```
6200
+
6201
+ ## `codiac environment create [NAME]`
6202
+
6203
+ Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.
6204
+
6205
+ ```
6206
+ USAGE
6207
+ $ codiac environment create [NAME] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
6208
+ [--withoutdefaults] [-v] [-h]
6209
+
6210
+ ARGUMENTS
6211
+ NAME The name of the environment to create
6212
+
6213
+ FLAGS
6214
+ -h, --help Show CLI help.
6215
+ -v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
6216
+ --as=<value> Fires this command with an argument list that was previously remembered using the --rememberAs
6217
+ flag.
6218
+ --remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
6219
+ --rememberAs=<value> Saves the given argument list so that it can be called by name.
6220
+ --unremember=<value> Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
6221
+ previously stored under the given name (use "--unRemember default" to clear default argument
6222
+ list memorized with the --remember flag).
6223
+ --withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
6224
+
6225
+ DESCRIPTION
6226
+ Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an
6227
+ error if the cabinet already exists.
6228
+
6229
+ ALIASES
6230
+ $ codiac enviro create
6231
+ ```
6232
+
6233
+ ## `codiac fileshare capture`
6234
+
6235
+ Creates a reference point in the given enterprise for an existing filestore instance in a cloud provider subscription.
6236
+
6237
+ ```
6238
+ USAGE
6239
+ $ codiac fileshare capture [-h] [--resourceGroup <value>] [-y -e <value> -n <value> --storageAccount <value>
6240
+ --shareName <value> --providerSubscriptionId <value> ]
6241
+
6242
+ FLAGS
6243
+ -e, --enterprise=<value> The name of the enterprise in which to create this asset. (defaults to the current
6244
+ enterprise context)
6245
+ -h, --help Show CLI help.
6246
+ -n, --name=<value> The name by which to identify this fileshare definition within the enterprise
6247
+ (Optional: defaults to the shareName).
6248
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are
6249
+ remembered from prior runs. Requires:
6250
+ enterprise,name,storageAccount,shareName,providerSubscriptionId,resourceId,accessKey
6251
+ --providerSubscriptionId=<value> The identifier of the cloud provider subscription under which the file storage
6252
+ account resides.
6253
+ --resourceGroup=<value> The name of the Azure resource group under which the instance is to be created
6254
+ (Azure-specific).
6255
+ --shareName=<value> The name of the fileshare to connect to within the file storage account.
6256
+ --storageAccount=<value> The name within the cloud provider of the file storage account within which the
6257
+ share resides.
6258
+
6259
+ DESCRIPTION
6260
+ Creates a reference point in the given enterprise for an existing filestore instance in a cloud provider subscription.
6261
+
6262
+ ALIASES
6263
+ $ codiac fileshare capture
6264
+ ```
6265
+
6266
+ ## `codiac filestore capture`
6267
+
6268
+ Creates a reference point in the given enterprise for an existing filestore instance in a cloud provider subscription.
6269
+
6270
+ ```
6271
+ USAGE
6272
+ $ codiac filestore capture [-h] [--resourceGroup <value>] [-y -e <value> -n <value> --storageAccount <value>
6273
+ --shareName <value> --providerSubscriptionId <value> ]
6274
+
6275
+ FLAGS
6276
+ -e, --enterprise=<value> The name of the enterprise in which to create this asset. (defaults to the current
6277
+ enterprise context)
6278
+ -h, --help Show CLI help.
6279
+ -n, --name=<value> The name by which to identify this fileshare definition within the enterprise
6280
+ (Optional: defaults to the shareName).
6281
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are
6282
+ remembered from prior runs. Requires:
6283
+ enterprise,name,storageAccount,shareName,providerSubscriptionId,resourceId,accessKey
6284
+ --providerSubscriptionId=<value> The identifier of the cloud provider subscription under which the file storage
6285
+ account resides.
6286
+ --resourceGroup=<value> The name of the Azure resource group under which the instance is to be created
6287
+ (Azure-specific).
6288
+ --shareName=<value> The name of the fileshare to connect to within the file storage account.
6289
+ --storageAccount=<value> The name within the cloud provider of the file storage account within which the
6290
+ share resides.
6291
+
6292
+ DESCRIPTION
6293
+ Creates a reference point in the given enterprise for an existing filestore instance in a cloud provider subscription.
6294
+
6295
+ ALIASES
6296
+ $ codiac fileshare capture
6297
+ ```
6298
+
6299
+ ## `codiac help [COMMANDS]`
6300
+
6301
+ Display help for codiac.
6302
+
6303
+ ```
6304
+ USAGE
6305
+ $ codiac help [COMMANDS] [-n]
6306
+
6307
+ ARGUMENTS
6308
+ COMMANDS Command to show help for.
6309
+
6310
+ FLAGS
6311
+ -n, --nested-commands Include all nested commands in the output.
6312
+
6313
+ DESCRIPTION
6314
+ Display help for codiac.
6315
+ ```
6316
+
6317
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
6318
+
6319
+ ## `codiac host map [DOMAIN]`
6320
+
6321
+ Declares a strategy for mapping assets to ingress routes for a domain name.
6322
+
6323
+ ```
6324
+ USAGE
6325
+ $ codiac host map [DOMAIN] [-h] [-n <value>] [-e <value> | -v <value>] [-c <value> | ] [-x]
6326
+
6327
+ ARGUMENTS
6328
+ DOMAIN The domain name to route (eg: "my-company.com")
6329
+
6330
+ FLAGS
6331
+ -c, --cabinet=<value> The name of the cabinet on which to apply this naming strategy. Must be qualified by also
6332
+ setting enterprise. NOTE: You can leave this blank if there is only one. If cabinet names
6333
+ are not unique, use the --enterprise/-e argument to fully qualify the cabinet name.
6334
+ -e, --enterprise=<value> The name of the enterprise on which to apply this naming strategy. NOTE: You can leave this
6335
+ blank if there is only one.
6336
+ -h, --help Show CLI help.
6337
+ -n, --naming=<value> The host naming strategy to apply.
6338
+ -v, --environment=<value> The name of the environment on which to apply this naming strategy. Must be qualified by
6339
+ also setting enterprise. NOTE: You can leave this blank if there is only one.
6340
+ -x, --noninteractive Throws errors if user interaction is required.
6341
+
6342
+ DESCRIPTION
6343
+ Declares a strategy for mapping assets to ingress routes for a domain name.
6344
+
6345
+ ALIASES
6346
+ $ codiac domain map
6347
+ ```
6348
+
6349
+ ## `codiac identity delete [NAME]`
6350
+
6351
+ Removes an identity token from storage for the current user.
6352
+
6353
+ ```
6354
+ USAGE
6355
+ $ codiac identity delete [NAME] [-h]
6356
+
6357
+ ARGUMENTS
6358
+ NAME The name of the token to delete. Use the 'identity:list' command to view the currently stored tokens.
6359
+
6360
+ FLAGS
6361
+ -h, --help Displays the help document for this command.
6362
+
6363
+ DESCRIPTION
6364
+ Removes an identity token from storage for the current user.
6365
+
6366
+ ALIASES
6367
+ $ codiac identity remove
6368
+ $ codiac token delete
6369
+ $ codiac token remove
6370
+ ```
6371
+
6372
+ ## `codiac identity remove [NAME]`
6373
+
6374
+ Removes an identity token from storage for the current user.
6375
+
6376
+ ```
6377
+ USAGE
6378
+ $ codiac identity remove [NAME] [-h]
6379
+
6380
+ ARGUMENTS
6381
+ NAME The name of the token to delete. Use the 'identity:list' command to view the currently stored tokens.
6382
+
6383
+ FLAGS
6384
+ -h, --help Displays the help document for this command.
6385
+
6386
+ DESCRIPTION
6387
+ Removes an identity token from storage for the current user.
6388
+
6389
+ ALIASES
6390
+ $ codiac identity remove
6391
+ $ codiac token delete
6392
+ $ codiac token remove
6393
+ ```
6394
+
6395
+ ## `codiac image [IMAGENAME]`
6396
+
6397
+ Configures a container image to be built and published by the project.
6398
+
6399
+ ```
6400
+ USAGE
6401
+ $ codiac image [IMAGENAME] [-h] [-i <value>] [-e <value>] [-s <value>] [-y -r <value> -p <value> -f
6402
+ <value> -u <value> ] [-b <value>]
6403
+
6404
+ ARGUMENTS
6405
+ IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
6406
+
6407
+ FLAGS
6408
+ -b, --buildParams=<value>...
6409
+ Additional freeform arguments to apply to the Docker build command.
6410
+
6411
+ -e, --environment=<value>
6412
+ (optional) Declaration that this registry shall be the target when publishing to the given environment.
6413
+
6414
+ -f, --sourceFile=<value>
6415
+ Path and filename of the image definition file, relative to the project root, (eg: "./Dockerfile"). If omitted, the
6416
+ build will use an in-memory image definition auto-generated at build time.
6417
+
6418
+ -h, --help
6419
+ Show CLI help.
6420
+
6421
+ -i, --infoUrl=<value>
6422
+ (Optional) Address on the registry website or portal of the human-readable web page for the image.
6423
+
6424
+ -p, --port=<value>
6425
+ Recommended port number to assign, in the toybox template, to an Asset defined by this image.
6426
+
6427
+ -r, --registryUrl=<value>
6428
+ [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the container registry to which
6429
+ the image will be published (without protocol prefix), eg: "yourimages.azurecr.io". NOTE: This registry will be
6430
+ used by the "publish" command, whereas when running in "local" mode, images will instead be registered to the
6431
+ built-in image registry on the local machine. NOTE: This url shall define the default publishing target, for use
6432
+ when publishing for any environment, unless otherwise specified.
6433
+
6434
+ -s, --password=<value>
6435
+ (optional) Password credential for the given registry. WARNING!! these username/password credentials will be stored
6436
+ in the codiac config file in this project, and therefore configuring username and password in this manner is not
6437
+ recommended!
6438
+
6439
+ -u, --username=<value>
6440
+ (optional) Login credential for the given registry. WARNING!! these username/password credentials will be stored in
6441
+ the codiac config file in this project, and therefore configuring username and password in this manner is not
6442
+ recommended!
6443
+
6444
+ -y, --silent
6445
+ (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs. Requires:
6446
+ registryUrl,port,sourceFile,username,name
6447
+
6448
+ DESCRIPTION
6449
+ Configures a container image to be built and published by the project.
6450
+
6451
+ ALIASES
6452
+ $ codiac image
6453
+ $ codiac image add
6454
+ $ codiac img
6455
+ $ codiac img add
6456
+ ```
6457
+
6458
+ ## `codiac image add [IMAGENAME]`
6459
+
6460
+ Configures a container image to be built and published by the project.
6461
+
6462
+ ```
6463
+ USAGE
6464
+ $ codiac image add [IMAGENAME] [-h] [-i <value>] [-e <value>] [-s <value>] [-y -r <value> -p <value> -f
6465
+ <value> -u <value> ] [-b <value>]
6466
+
6467
+ ARGUMENTS
6468
+ IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
6469
+
6470
+ FLAGS
6471
+ -b, --buildParams=<value>...
6472
+ Additional freeform arguments to apply to the Docker build command.
6473
+
6474
+ -e, --environment=<value>
6475
+ (optional) Declaration that this registry shall be the target when publishing to the given environment.
6476
+
6477
+ -f, --sourceFile=<value>
6478
+ Path and filename of the image definition file, relative to the project root, (eg: "./Dockerfile"). If omitted, the
6479
+ build will use an in-memory image definition auto-generated at build time.
6480
+
6481
+ -h, --help
6482
+ Show CLI help.
6483
+
6484
+ -i, --infoUrl=<value>
6485
+ (Optional) Address on the registry website or portal of the human-readable web page for the image.
6486
+
6487
+ -p, --port=<value>
6488
+ Recommended port number to assign, in the toybox template, to an Asset defined by this image.
6489
+
6490
+ -r, --registryUrl=<value>
6491
+ [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the container registry to which
6492
+ the image will be published (without protocol prefix), eg: "yourimages.azurecr.io". NOTE: This registry will be
6493
+ used by the "publish" command, whereas when running in "local" mode, images will instead be registered to the
6494
+ built-in image registry on the local machine. NOTE: This url shall define the default publishing target, for use
6495
+ when publishing for any environment, unless otherwise specified.
6496
+
6497
+ -s, --password=<value>
6498
+ (optional) Password credential for the given registry. WARNING!! these username/password credentials will be stored
6499
+ in the codiac config file in this project, and therefore configuring username and password in this manner is not
6500
+ recommended!
6501
+
6502
+ -u, --username=<value>
6503
+ (optional) Login credential for the given registry. WARNING!! these username/password credentials will be stored in
6504
+ the codiac config file in this project, and therefore configuring username and password in this manner is not
6505
+ recommended!
6506
+
6507
+ -y, --silent
6508
+ (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs. Requires:
6509
+ registryUrl,port,sourceFile,username,name
6510
+
6511
+ DESCRIPTION
6512
+ Configures a container image to be built and published by the project.
6513
+
6514
+ ALIASES
6515
+ $ codiac image
6516
+ $ codiac image add
6517
+ $ codiac img
6518
+ $ codiac img add
6519
+ ```
6520
+
6521
+ ## `codiac image delete IMAGENAME`
6522
+
6523
+ Deletes the given image export from the configuration.
6524
+
6525
+ ```
6526
+ USAGE
6527
+ $ codiac image delete IMAGENAME [-h]
6528
+
6529
+ ARGUMENTS
6530
+ IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
6531
+
6532
+ FLAGS
6533
+ -h, --help Show CLI help.
6534
+
6535
+ DESCRIPTION
6536
+ Deletes the given image export from the configuration.
6537
+
6538
+ ALIASES
6539
+ $ codiac image remove
6540
+ $ codiac img remove
6541
+ $ codiac image delete
6542
+ $ codiac img delete
6543
+ ```
6544
+
6545
+ ## `codiac image patch IMAGENAME`
6546
+
6547
+ 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.
6548
+
6549
+ ```
6550
+ USAGE
6551
+ $ codiac image patch IMAGENAME [-h] [-s <value>] [-u <value>]
6552
+
6553
+ ARGUMENTS
6554
+ IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
6555
+
6556
+ FLAGS
6557
+ -h, --help Show CLI help.
6558
+ -s, --set=<value> Space-delimited list of key-value pairs tp apply with json-path on the left and the desired value
6559
+ on the right. (eg: --set .targets.default.registryUrl=mystuff.azurecr.io)
6560
+ -u, --unset=<value> Space-delimited list of properties to clear, in json-path format. (eg: --unset
6561
+ .targets.default)
6562
+
6563
+ DESCRIPTION
6564
+ Applies the given values to an existing image export configuration. Both registryUrl and environment act as filters
6565
+ to limit the operation. That is, an upsert of registry targets is performed for the given image, based on the given
6566
+ registryUrl and/or environment.
6567
+
6568
+ ALIASES
6569
+ $ codiac image patch
6570
+ $ codiac img patch
6571
+ ```
6572
+
6573
+ ## `codiac image remove IMAGENAME`
6574
+
6575
+ Deletes the given image export from the configuration.
6576
+
6577
+ ```
6578
+ USAGE
6579
+ $ codiac image remove IMAGENAME [-h]
6580
+
6581
+ ARGUMENTS
6582
+ IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
6583
+
6584
+ FLAGS
6585
+ -h, --help Show CLI help.
6586
+
6587
+ DESCRIPTION
6588
+ Deletes the given image export from the configuration.
6589
+
6590
+ ALIASES
6591
+ $ codiac image remove
6592
+ $ codiac img remove
6593
+ $ codiac image delete
6594
+ $ codiac img delete
6595
+ ```
6596
+
6597
+ ## `codiac imageRegistry forget`
6598
+
6599
+ Removes the reference to the given container registry for the tenant. Does NOT delete the registry itself.
6600
+
6601
+ ```
6602
+ USAGE
6603
+ $ codiac imageRegistry forget [-z] [-y -r <value>] [-h]
6604
+
6605
+ FLAGS
6606
+ -h, --help Show CLI help.
6607
+ -r, --registry=<value> The container registry to forget.
6608
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
6609
+ prior runs. Requires: registry
6610
+ -z, --toScript Outputs an assembled command string, NO execution
6611
+
6612
+ DESCRIPTION
6613
+ Removes the reference to the given container registry for the tenant. Does NOT delete the registry itself.
6614
+ ```
6615
+
6616
+ ## `codiac images add [IMAGENAME]`
6617
+
6618
+ Configures a container image to be built and published by the project.
6619
+
6620
+ ```
6621
+ USAGE
6622
+ $ codiac images add [IMAGENAME] [-h] [-i <value>] [-e <value>] [-s <value>] [-y -r <value> -p <value> -f
6623
+ <value> -u <value> ] [-b <value>]
6624
+
6625
+ ARGUMENTS
6626
+ IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
6627
+
6628
+ FLAGS
6629
+ -b, --buildParams=<value>...
6630
+ Additional freeform arguments to apply to the Docker build command.
6631
+
6632
+ -e, --environment=<value>
6633
+ (optional) Declaration that this registry shall be the target when publishing to the given environment.
6634
+
6635
+ -f, --sourceFile=<value>
6636
+ Path and filename of the image definition file, relative to the project root, (eg: "./Dockerfile"). If omitted, the
6637
+ build will use an in-memory image definition auto-generated at build time.
6638
+
6639
+ -h, --help
6640
+ Show CLI help.
6641
+
6642
+ -i, --infoUrl=<value>
6643
+ (Optional) Address on the registry website or portal of the human-readable web page for the image.
6644
+
6645
+ -p, --port=<value>
6646
+ Recommended port number to assign, in the toybox template, to an Asset defined by this image.
6647
+
6648
+ -r, --registryUrl=<value>
6649
+ [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the container registry to which
6650
+ the image will be published (without protocol prefix), eg: "yourimages.azurecr.io". NOTE: This registry will be
6651
+ used by the "publish" command, whereas when running in "local" mode, images will instead be registered to the
6652
+ built-in image registry on the local machine. NOTE: This url shall define the default publishing target, for use
6653
+ when publishing for any environment, unless otherwise specified.
6654
+
6655
+ -s, --password=<value>
6656
+ (optional) Password credential for the given registry. WARNING!! these username/password credentials will be stored
6657
+ in the codiac config file in this project, and therefore configuring username and password in this manner is not
6658
+ recommended!
6659
+
6660
+ -u, --username=<value>
6661
+ (optional) Login credential for the given registry. WARNING!! these username/password credentials will be stored in
6662
+ the codiac config file in this project, and therefore configuring username and password in this manner is not
6663
+ recommended!
6664
+
6665
+ -y, --silent
6666
+ (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs. Requires:
6667
+ registryUrl,port,sourceFile,username,name
6668
+
6669
+ DESCRIPTION
6670
+ Configures a container image to be built and published by the project.
6671
+
6672
+ ALIASES
6673
+ $ codiac image
6674
+ $ codiac image add
6675
+ $ codiac img
6676
+ $ codiac img add
6677
+ ```
6678
+
6679
+ ## `codiac images patch IMAGENAME`
6680
+
6681
+ 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.
6682
+
6683
+ ```
6684
+ USAGE
6685
+ $ codiac images patch IMAGENAME [-h] [-s <value>] [-u <value>]
6686
+
6687
+ ARGUMENTS
6688
+ IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
6689
+
6690
+ FLAGS
6691
+ -h, --help Show CLI help.
6692
+ -s, --set=<value> Space-delimited list of key-value pairs tp apply with json-path on the left and the desired value
6693
+ on the right. (eg: --set .targets.default.registryUrl=mystuff.azurecr.io)
6694
+ -u, --unset=<value> Space-delimited list of properties to clear, in json-path format. (eg: --unset
6695
+ .targets.default)
6696
+
6697
+ DESCRIPTION
6698
+ Applies the given values to an existing image export configuration. Both registryUrl and environment act as filters
6699
+ to limit the operation. That is, an upsert of registry targets is performed for the given image, based on the given
6700
+ registryUrl and/or environment.
6701
+
6702
+ ALIASES
6703
+ $ codiac image patch
6704
+ $ codiac img patch
6705
+ ```
6706
+
6707
+ ## `codiac images remove IMAGENAME`
6708
+
6709
+ Deletes the given image export from the configuration.
6710
+
6711
+ ```
6712
+ USAGE
6713
+ $ codiac images remove IMAGENAME [-h]
6714
+
6715
+ ARGUMENTS
6716
+ IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
6717
+
6718
+ FLAGS
6719
+ -h, --help Show CLI help.
6720
+
6721
+ DESCRIPTION
6722
+ Deletes the given image export from the configuration.
6723
+
6724
+ ALIASES
6725
+ $ codiac image remove
6726
+ $ codiac img remove
6727
+ $ codiac image delete
6728
+ $ codiac img delete
6729
+ ```
6730
+
6731
+ ## `codiac img [IMAGENAME]`
6732
+
6733
+ Configures a container image to be built and published by the project.
6734
+
6735
+ ```
6736
+ USAGE
6737
+ $ codiac img [IMAGENAME] [-h] [-i <value>] [-e <value>] [-s <value>] [-y -r <value> -p <value> -f
6738
+ <value> -u <value> ] [-b <value>]
6739
+
6740
+ ARGUMENTS
6741
+ IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
6742
+
6743
+ FLAGS
6744
+ -b, --buildParams=<value>...
6745
+ Additional freeform arguments to apply to the Docker build command.
6746
+
6747
+ -e, --environment=<value>
6748
+ (optional) Declaration that this registry shall be the target when publishing to the given environment.
6749
+
6750
+ -f, --sourceFile=<value>
6751
+ Path and filename of the image definition file, relative to the project root, (eg: "./Dockerfile"). If omitted, the
6752
+ build will use an in-memory image definition auto-generated at build time.
6753
+
6754
+ -h, --help
6755
+ Show CLI help.
6756
+
6757
+ -i, --infoUrl=<value>
6758
+ (Optional) Address on the registry website or portal of the human-readable web page for the image.
6759
+
6760
+ -p, --port=<value>
6761
+ Recommended port number to assign, in the toybox template, to an Asset defined by this image.
6762
+
6763
+ -r, --registryUrl=<value>
6764
+ [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the container registry to which
6765
+ the image will be published (without protocol prefix), eg: "yourimages.azurecr.io". NOTE: This registry will be
6766
+ used by the "publish" command, whereas when running in "local" mode, images will instead be registered to the
6767
+ built-in image registry on the local machine. NOTE: This url shall define the default publishing target, for use
6768
+ when publishing for any environment, unless otherwise specified.
6769
+
6770
+ -s, --password=<value>
6771
+ (optional) Password credential for the given registry. WARNING!! these username/password credentials will be stored
6772
+ in the codiac config file in this project, and therefore configuring username and password in this manner is not
6773
+ recommended!
6774
+
6775
+ -u, --username=<value>
6776
+ (optional) Login credential for the given registry. WARNING!! these username/password credentials will be stored in
6777
+ the codiac config file in this project, and therefore configuring username and password in this manner is not
6778
+ recommended!
6779
+
6780
+ -y, --silent
6781
+ (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs. Requires:
6782
+ registryUrl,port,sourceFile,username,name
6783
+
6784
+ DESCRIPTION
6785
+ Configures a container image to be built and published by the project.
6786
+
6787
+ ALIASES
6788
+ $ codiac image
6789
+ $ codiac image add
6790
+ $ codiac img
6791
+ $ codiac img add
6792
+ ```
6793
+
6794
+ ## `codiac img add [IMAGENAME]`
6795
+
6796
+ Configures a container image to be built and published by the project.
6797
+
6798
+ ```
6799
+ USAGE
6800
+ $ codiac img add [IMAGENAME] [-h] [-i <value>] [-e <value>] [-s <value>] [-y -r <value> -p <value> -f
6801
+ <value> -u <value> ] [-b <value>]
6802
+
6803
+ ARGUMENTS
6804
+ IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
6805
+
6806
+ FLAGS
6807
+ -b, --buildParams=<value>...
6808
+ Additional freeform arguments to apply to the Docker build command.
6809
+
6810
+ -e, --environment=<value>
6811
+ (optional) Declaration that this registry shall be the target when publishing to the given environment.
6812
+
6813
+ -f, --sourceFile=<value>
6814
+ Path and filename of the image definition file, relative to the project root, (eg: "./Dockerfile"). If omitted, the
6815
+ build will use an in-memory image definition auto-generated at build time.
6816
+
6817
+ -h, --help
6818
+ Show CLI help.
6819
+
6820
+ -i, --infoUrl=<value>
6821
+ (Optional) Address on the registry website or portal of the human-readable web page for the image.
6822
+
6823
+ -p, --port=<value>
6824
+ Recommended port number to assign, in the toybox template, to an Asset defined by this image.
6825
+
6826
+ -r, --registryUrl=<value>
6827
+ [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the container registry to which
6828
+ the image will be published (without protocol prefix), eg: "yourimages.azurecr.io". NOTE: This registry will be
6829
+ used by the "publish" command, whereas when running in "local" mode, images will instead be registered to the
6830
+ built-in image registry on the local machine. NOTE: This url shall define the default publishing target, for use
6831
+ when publishing for any environment, unless otherwise specified.
6832
+
6833
+ -s, --password=<value>
6834
+ (optional) Password credential for the given registry. WARNING!! these username/password credentials will be stored
6835
+ in the codiac config file in this project, and therefore configuring username and password in this manner is not
6836
+ recommended!
6837
+
6838
+ -u, --username=<value>
6839
+ (optional) Login credential for the given registry. WARNING!! these username/password credentials will be stored in
6840
+ the codiac config file in this project, and therefore configuring username and password in this manner is not
6841
+ recommended!
6842
+
6843
+ -y, --silent
6844
+ (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs. Requires:
6845
+ registryUrl,port,sourceFile,username,name
6846
+
6847
+ DESCRIPTION
6848
+ Configures a container image to be built and published by the project.
6849
+
6850
+ ALIASES
6851
+ $ codiac image
6852
+ $ codiac image add
6853
+ $ codiac img
6854
+ $ codiac img add
6855
+ ```
6856
+
6857
+ ## `codiac img delete IMAGENAME`
6858
+
6859
+ Deletes the given image export from the configuration.
6860
+
6861
+ ```
6862
+ USAGE
6863
+ $ codiac img delete IMAGENAME [-h]
6864
+
6865
+ ARGUMENTS
6866
+ IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
6867
+
6868
+ FLAGS
6869
+ -h, --help Show CLI help.
6870
+
6871
+ DESCRIPTION
6872
+ Deletes the given image export from the configuration.
6873
+
6874
+ ALIASES
6875
+ $ codiac image remove
6876
+ $ codiac img remove
6877
+ $ codiac image delete
6878
+ $ codiac img delete
6879
+ ```
6880
+
6881
+ ## `codiac img patch IMAGENAME`
6882
+
6883
+ 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.
6884
+
6885
+ ```
6886
+ USAGE
6887
+ $ codiac img patch IMAGENAME [-h] [-s <value>] [-u <value>]
6888
+
6889
+ ARGUMENTS
6890
+ IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
6891
+
6892
+ FLAGS
6893
+ -h, --help Show CLI help.
6894
+ -s, --set=<value> Space-delimited list of key-value pairs tp apply with json-path on the left and the desired value
6895
+ on the right. (eg: --set .targets.default.registryUrl=mystuff.azurecr.io)
6896
+ -u, --unset=<value> Space-delimited list of properties to clear, in json-path format. (eg: --unset
6897
+ .targets.default)
6898
+
6899
+ DESCRIPTION
6900
+ Applies the given values to an existing image export configuration. Both registryUrl and environment act as filters
6901
+ to limit the operation. That is, an upsert of registry targets is performed for the given image, based on the given
6902
+ registryUrl and/or environment.
6903
+
6904
+ ALIASES
6905
+ $ codiac image patch
6906
+ $ codiac img patch
6907
+ ```
6908
+
6909
+ ## `codiac img remove IMAGENAME`
6910
+
6911
+ Deletes the given image export from the configuration.
6912
+
6913
+ ```
6914
+ USAGE
6915
+ $ codiac img remove IMAGENAME [-h]
6916
+
6917
+ ARGUMENTS
6918
+ IMAGENAME image name including, scope prefix. eg: "your-company/your-image"
6919
+
6920
+ FLAGS
6921
+ -h, --help Show CLI help.
6922
+
6923
+ DESCRIPTION
6924
+ Deletes the given image export from the configuration.
6925
+
6926
+ ALIASES
6927
+ $ codiac image remove
6928
+ $ codiac img remove
6929
+ $ codiac image delete
6930
+ $ codiac img delete
6931
+ ```
6932
+
6933
+ ## `codiac init DIRECTORY`
6934
+
6935
+ Declares the given folder as a project root
6936
+
6937
+ ```
6938
+ USAGE
6939
+ $ codiac init DIRECTORY [-h] [-c <value>] [-t <value>]
6940
+
6941
+ ARGUMENTS
6942
+ DIRECTORY Path to the desired project root, relative to current directory.
6943
+
6944
+ FLAGS
6945
+ -c, --clone=<value> (Optional) The git repo from which to hydrate the project folder.
6946
+ -h, --help Show CLI help.
6947
+ -t, --projectType=<value> (Optional) The type of Codiac project to scaffold.
6948
+
6949
+ DESCRIPTION
6950
+ Declares the given folder as a project root
6951
+ ```
6952
+
6953
+ _See code: [src/commands/init.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/init.ts)_
6954
+
6955
+ ## `codiac k9s`
6956
+
6957
+ Spins up the k9s cli pod viewer
6958
+
6959
+ ```
6960
+ USAGE
6961
+ $ codiac k9s [-h]
6962
+
6963
+ FLAGS
6964
+ -h, --help Show CLI help.
6965
+
6966
+ DESCRIPTION
6967
+ Spins up the k9s cli pod viewer
6968
+
6969
+ ALIASES
6970
+ $ codiac view k9s
6971
+ $ codiac k9s
6972
+ ```
6973
+
6974
+ ## `codiac kit create [SETTING]`
6975
+
6976
+ Creates a new kit from an existing asset.
6977
+
6978
+ ```
6979
+ USAGE
6980
+ $ codiac kit create [SETTING] [-h] [-s <value>] [-y -a <value> -e <value> -n <value> ]
6981
+
6982
+ ARGUMENTS
6983
+ SETTING The key for the config setting to add
6984
+
6985
+ FLAGS
6986
+ -a, --asset=<value> The enterprise asset from which to create the kit.
6987
+ -e, --enterprise=<value> The name of the enterprise containing the given asset. (defaults to the current enterprise
6988
+ context)
6989
+ -h, --help Show CLI help.
6990
+ -n, --name=<value> Override for the name to give the new kit (Optional: defaults to the asset name).
6991
+ -s, --scope=<value> The globally unique name for the directory in which to register the kit. This value
6992
+ prefixes the kit name to ensure global uniqueness (Optional: defaults to the public shared
6993
+ library).
6994
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
6995
+ prior runs. Requires:
6996
+ asset,enterprise,name,code,enterprise,port,hasIngress,routedWithoutName
6997
+
6998
+ DESCRIPTION
6999
+ Creates a new kit from an existing asset.
7000
+ ```
7001
+
7002
+ ## `codiac login`
7003
+
7004
+ Codiac system login to authenticate user under a tenant.
7005
+
7006
+ ```
7007
+ USAGE
7008
+ $ codiac login [-h] [-t <value>] [-o -u <value> [-i | -p <value>]] [-y ]
7009
+
7010
+ FLAGS
7011
+ -h, --help Show CLI help.
7012
+ -i, --passwordIn Reads the password directly from the standard input stream. Enables users to avoid
7013
+ explicitly rendering it in a command string. eg: `cat mypass.txt | cod login -u joecool
7014
+ --passwordIn`. Invokes `--silent` mode, so interaction will be disabled.
7015
+ -o, --tokenOut Writes the token as the sole stdout content (so that it is available to be piped or
7016
+ redirected elsewhere, eg `cod login > mycodiactoken.txt`). Leaves stdout empty on errors.
7017
+ Invokes `--silent` mode, so interaction will be disabled.
7018
+ -p, --password=<value> password on Codiac
7019
+ -t, --tenantCode=<value> Human-readable Identifier for the Codiac tenant to log in under (optional: defaults to the
7020
+ tenant code for the current project or prompts you to select one from your profile).
7021
+ -u, --username=<value> Username on Codiac
7022
+ -y, --silent (Optional: defaults to false) Prevents interactive user-interface and throws if interaction
7023
+ is needed. Requires arguments: [--username -u, --passwordIn -i]
7024
+
7025
+ DESCRIPTION
7026
+ Codiac system login to authenticate user under a tenant.
7027
+
7028
+ ALIASES
7029
+ $ codiac user login
7030
+ ```
7031
+
7032
+ _See code: [src/commands/login.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/login.ts)_
7033
+
7034
+ ## `codiac logout`
7035
+
7036
+ Resets the current user to anonymous and clears any local user cache.
7037
+
7038
+ ```
7039
+ USAGE
7040
+ $ codiac logout
7041
+
7042
+ DESCRIPTION
7043
+ Resets the current user to anonymous and clears any local user cache.
7044
+
7045
+ EXAMPLES
7046
+ $ codiac logout
7047
+ ```
7048
+
7049
+ _See code: [src/commands/logout.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/logout.ts)_
7050
+
7051
+ ## `codiac merge [BRANCH]`
7052
+
7053
+ Merges the given branch into the current branch of the main project and on any sourced dependencies.
7054
+
7055
+ ```
7056
+ USAGE
7057
+ $ codiac merge [BRANCH] [-h] [-c]
7058
+
7059
+ ARGUMENTS
7060
+ BRANCH The branch name to merge into the current one.
7061
+
7062
+ FLAGS
7063
+ -c, --commit Commits if merge succeeds.
7064
+ -h, --help Show CLI help.
7065
+
7066
+ DESCRIPTION
7067
+ Merges the given branch into the current branch of the main project and on any sourced dependencies.
7068
+ ```
7069
+
7070
+ _See code: [src/commands/merge.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/merge.ts)_
7071
+
7072
+ ## `codiac noc cluster create [NAME]`
7073
+
7074
+ Provisions the physical cluster
7075
+
7076
+ ```
7077
+ USAGE
7078
+ $ codiac noc cluster create [NAME] [-h] [-p <value>] [-k <value>] [-u <value>] [-u <value>] [-y <value> -s <value> -g
7079
+ <value> -l <value> -n <value> -q <value>] [-t]
7080
+
7081
+ ARGUMENTS
7082
+ NAME Proposed name of the cluster
7083
+
7084
+ FLAGS
7085
+ -g, --resourceGroup=<value> The Azure resource group to create for the cluster.
7086
+ -h, --help Show CLI help.
7087
+ -k, --subnet=<value> The resource id of the subnet in which the cluster is to be created.
7088
+ -l, --location=<value> The short name of the azure data center in which the cliuster is to reside.
7089
+ -n, --nodeSpec=<value> The identifier for the type of VM to use for nodes in the cluster.
7090
+ -p, --owner=<value> Tenant code of the private owner of the cluster
7091
+ -q, --nodeQty=<value> The starting node count with which to create the cluster.
7092
+ -s, --providerSubscription=<value> The Azure subscription Id under which to create the cluster.
7093
+ -t, --toScript Outputs an assembled command string, NO execution
7094
+ -u, --identityUserId=<value> OPTIONAL. ID of Svc Principal or Managed Identity to execute as. To create k8s
7095
+ cluster, IP address, and container Pull. If none supplied Codiac will try to
7096
+ create one.
7097
+ -u, --identityUserName=<value> OPTIONAL. Name of Svc Principal or Managed Identity to execute as. To create k8s
7098
+ cluster, IP address, and container Pull. If none supplied Codiac will try to
7099
+ create one.
7100
+ -y, --silent=<value> (Optional: defaults to false) Prevents confirmations of user-values. Required:
7101
+ providerSubscription,resourceGroup,location,nodeSpec,nodeQty
7102
+
7103
+ DESCRIPTION
7104
+ Provisions the physical cluster
7105
+
7106
+ ALIASES
7107
+ $ codiac cluster create
7108
+ ```
7109
+
7110
+ ## `codiac pkg add [DEFINITIONFILE]`
7111
+
7112
+ Configures a package to be built and published by the project.
7113
+
7114
+ ```
7115
+ USAGE
7116
+ $ codiac pkg add [DEFINITIONFILE] [-h] [-r <value>] [-e <value>] [-u <value>] [-s <value>]
7117
+
7118
+ ARGUMENTS
7119
+ DEFINITIONFILE Path and filename of the package definition file, relative to the codiac project root, (eg:
7120
+ "./package.json")
7121
+
7122
+ FLAGS
7123
+ -e, --environment=<value> (optional) Declaration that this registry shall be the target when publishing to the given
7124
+ environment.
7125
+ -h, --help Show CLI help.
7126
+ -r, --registryUrl=<value> Address of the registry to which the package will be published (without protocol prefix),
7127
+ eg: "yourpackages.azurecr.io". NOTE: This registry will be used by the "codiac publish"
7128
+ command, whereas when running in "local" mode, packages will instead be registered to the
7129
+ built-in package registry on the local machine. NOTE: This url shall define the default
7130
+ publishing target, for use when publishing for any environment, unless otherwise specified.
7131
+ -s, --password=<value> (optional) Password credential for the given registry. WARNING!! these username/password
7132
+ credentials will be stored in the codiac config file in this project, and therefore
7133
+ configuring username and password in this manner is not recommended!
7134
+ -u, --username=<value> (optional) Login credential for the given registry. WARNING!! these username/password
7135
+ credentials will be stored in the codiac config file in this project, and therefore
7136
+ configuring username and password in this manner is not recommended!
7137
+
7138
+ DESCRIPTION
7139
+ Configures a package to be built and published by the project.
7140
+ ```
7141
+
7142
+ ## `codiac pkg delete [PACKAGENAME]`
7143
+
7144
+ Deletes the given package export from the configuration.
7145
+
7146
+ ```
7147
+ USAGE
7148
+ $ codiac pkg delete [PACKAGENAME] [-h]
7149
+
7150
+ ARGUMENTS
7151
+ PACKAGENAME package name including, scope prefix. eg: "your-company/your-package"
7152
+
7153
+ FLAGS
7154
+ -h, --help Show CLI help.
7155
+
7156
+ DESCRIPTION
7157
+ Deletes the given package export from the configuration.
7158
+
7159
+ ALIASES
7160
+ $ codiac pkg delete
7161
+ ```
7162
+
7163
+ ## `codiac pkg list [HELLO]`
7164
+
7165
+ Renders the list of packages that are configured as project exports.
7166
+
7167
+ ```
7168
+ USAGE
7169
+ $ codiac pkg list [HELLO] [-h]
7170
+
7171
+ FLAGS
7172
+ -h, --help Show CLI help.
7173
+
7174
+ DESCRIPTION
7175
+ Renders the list of packages that are configured as project exports.
7176
+ ```
7177
+
7178
+ ## `codiac pkg patch PACKAGENAME`
7179
+
7180
+ 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.
7181
+
7182
+ ```
7183
+ USAGE
7184
+ $ codiac pkg patch PACKAGENAME [-h] [-s <value>] [-u <value>]
7185
+
7186
+ ARGUMENTS
7187
+ PACKAGENAME package name including, scope prefix. eg: "your-company/your-package"
7188
+
7189
+ FLAGS
7190
+ -h, --help Show CLI help.
7191
+ -s, --set=<value> Space-delimited list of key-value pairs tp apply with json-path on the left and the desired value
7192
+ on the right. (eg: --set .targets.default.registryUrl=mystuff.azurecr.io)
7193
+ -u, --unset=<value> Space-delimited list of properties to clear, in json-path format. (eg: --unset
7194
+ .targets.default)
7195
+
7196
+ DESCRIPTION
7197
+ Applies the given values to an existing package export configuration. Both registryUrl and environment act as filters
7198
+ to limit the operation. That is, an upsert of registry targets is performed for the given package, based on the given
7199
+ registryUrl and/or environment.
7200
+ ```
7201
+
7202
+ ## `codiac pkg remove [PACKAGENAME]`
7203
+
7204
+ Deletes the given package export from the configuration.
7205
+
7206
+ ```
7207
+ USAGE
7208
+ $ codiac pkg remove [PACKAGENAME] [-h]
7209
+
7210
+ ARGUMENTS
7211
+ PACKAGENAME package name including, scope prefix. eg: "your-company/your-package"
7212
+
7213
+ FLAGS
7214
+ -h, --help Show CLI help.
7215
+
7216
+ DESCRIPTION
7217
+ Deletes the given package export from the configuration.
7218
+
7219
+ ALIASES
7220
+ $ codiac pkg delete
7221
+ ```
7222
+
7223
+ ## `codiac portal`
7224
+
7225
+ Starts the codiac relay services, maintains container instance, and opens the web app.
7226
+
7227
+ ```
7228
+ USAGE
7229
+ $ codiac portal
7230
+
7231
+ DESCRIPTION
7232
+ Starts the codiac relay services, maintains container instance, and opens the web app.
7233
+ ```
7234
+
7235
+ _See code: [src/commands/portal.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/portal.ts)_
7236
+
7237
+ ## `codiac publish [NAME]`
7238
+
7239
+ Publishes the exports (packages and images) declared in the ProjectConfig.
7240
+
7241
+ ```
7242
+ USAGE
7243
+ $ codiac publish [NAME] [-h] [-r] [-l] [-y -i <value> -u <value> -p <value>] [-o] [-i]
7244
+
7245
+ ARGUMENTS
7246
+ NAME The official unique name of a currently sourced dependency. Applies the command to ONLY this sourced
7247
+ dependency.
7248
+
7249
+ FLAGS
7250
+ -h, --help Show CLI help.
7251
+ -i, --image=<value>... (optional, defaults to all) Limits the list of images to publish. Value must match the name
7252
+ property of an image export defined in the codiac project file (codiac.json)
7253
+ -i, --includeDeps Also performs the operation on any currently source dependencies.
7254
+ -l, --local Publishes to the local built-in image registry. NOTE: this setting gets remembered and is
7255
+ used for subsequent calls unless otherwise specified.
7256
+ -o, --only Applies the command only the sourced dependencies selected from a prompt. Quits if no
7257
+ dependencies are currently sourced.
7258
+ -p, --password=<value> (optional, prompts as needed) Password or token at the target registry.
7259
+ -r, --remote Publishes to the remote image registry. NOTE: this setting gets remembered and is used for
7260
+ subsequent calls unless otherwise specified.
7261
+ -u, --username=<value> (optional, prompts as needed) Username at the target registry.
7262
+ -y, --silent Suppresses user dialogue.
7263
+
7264
+ DESCRIPTION
7265
+ Publishes the exports (packages and images) declared in the ProjectConfig.
7266
+ ```
7267
+
7268
+ _See code: [src/commands/publish.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/publish.ts)_
7269
+
7270
+ ## `codiac pull [NAME]`
7271
+
7272
+ Pulls all commits from upstream to local.
7273
+
7274
+ ```
7275
+ USAGE
7276
+ $ codiac pull [NAME] [-h] [-o] [-i]
7277
+
7278
+ ARGUMENTS
7279
+ NAME The official unique name of a currently sourced dependency. Applies the command to ONLY this sourced
7280
+ dependency.
7281
+
7282
+ FLAGS
7283
+ -h, --help Show CLI help.
7284
+ -i, --includeDeps Also performs the operation on any currently source dependencies.
7285
+ -o, --only Applies the command only the sourced dependencies selected from a prompt. Quits if no dependencies
7286
+ are currently sourced.
7287
+
7288
+ DESCRIPTION
7289
+ Pulls all commits from upstream to local.
7290
+ ```
7291
+
7292
+ _See code: [src/commands/pull.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/pull.ts)_
7293
+
7294
+ ## `codiac push [NAME]`
7295
+
7296
+ Pushes all local commits upstream.
7297
+
7298
+ ```
7299
+ USAGE
7300
+ $ codiac push [NAME] [-h] [-o] [-i]
7301
+
7302
+ ARGUMENTS
7303
+ NAME The official unique name of a currently sourced dependency. Applies the command to ONLY this sourced
7304
+ dependency.
7305
+
7306
+ FLAGS
7307
+ -h, --help Show CLI help.
7308
+ -i, --includeDeps Also performs the operation on any currently source dependencies.
7309
+ -o, --only Applies the command only the sourced dependencies selected from a prompt. Quits if no dependencies
7310
+ are currently sourced.
7311
+
7312
+ DESCRIPTION
7313
+ Pushes all local commits upstream.
7314
+ ```
7315
+
7316
+ _See code: [src/commands/push.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/push.ts)_
7317
+
7318
+ ## `codiac run`
7319
+
7320
+ Runs the latest build of the api container locally.
7321
+
7322
+ ```
7323
+ USAGE
7324
+ $ codiac run [-b] [-d] [-e <value>] [-h] [-i] [-n <value>] [-m <value>] [-p <value>] [-l <value>] [-w]
7325
+ [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>] [--withoutdefaults] [-v]
7326
+
7327
+ FLAGS
7328
+ -b, --build Triggers a new local build beforehand.
7329
+ -d, --detach Run container in background and print the container ID.
7330
+ -e, --entrypoint=<value> Overrides the default container startup command.
7331
+ -h, --help Renders the help document for this command.
7332
+ -i, --interactive Run the container interactively (in the console; dies with the console). Use
7333
+ -e|--entrypoint to override the startup command for the container.
7334
+ -l, --internalPort=<value> (default: 5775) The port the application inside the container is listening on. Sets the
7335
+ port to which map incoming requests on the container. This port mapping MUST match
7336
+ whatever port number the actual application is listening on.
7337
+ -m, --mountFolder=<value> Mounts a folder on the host as a read-write volume on the container. In format
7338
+ "src=~/my/local/folder,dst=/root/in/container".
7339
+ -n, --network=<value> The docker network to which the container will be attached (defaults to a network named as
7340
+ the company code, which will be created on demand as a bridge network).
7341
+ -p, --port=<value> (default: 5775) Sets the external port to open on the container. That is, the port on
7342
+ which the api will be listening to calls from outside the container.
7343
+ -v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
7344
+ -w, --watch Forces a detach run and follows log output from the container.
7345
+ --as=<value> Fires this command with an argument list that was previously remembered using the
7346
+ --rememberAs flag.
7347
+ --remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
7348
+ --rememberAs=<value> Saves the given argument list so that it can be called by name.
7349
+ --unremember=<value> Administrative only: DOES NOT fire the actual command. Simply clears the arguments that
7350
+ were previously stored under the given name (use "--unRemember default" to clear default
7351
+ argument list memorized with the --remember flag).
7352
+ --withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
7353
+
7354
+ DESCRIPTION
7355
+ Runs the latest build of the api container locally.
7356
+ ```
7357
+
7358
+ _See code: [src/commands/run.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/run.ts)_
7359
+
7360
+ ## `codiac secretStore forget`
7361
+
7362
+ Removes the reference to the given container registry for the tenant. Does NOT delete the registry itself.
7363
+
7364
+ ```
7365
+ USAGE
7366
+ $ codiac secretStore forget [-z] [-y -n <value>] [-h]
7367
+
7368
+ FLAGS
7369
+ -h, --help Show CLI help.
7370
+ -n, --name=<value> The name of the secret store to forget.
7371
+ -y, --silent (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior
7372
+ runs. Requires: name
7373
+ -z, --toScript Outputs an assembled command string, NO execution
7374
+
7375
+ DESCRIPTION
7376
+ Removes the reference to the given container registry for the tenant. Does NOT delete the registry itself.
7377
+ ```
7378
+
7379
+ ## `codiac stage [FILES]`
7380
+
7381
+ Flags files to be included in the next commit.
7382
+
7383
+ ```
7384
+ USAGE
7385
+ $ codiac stage [FILES] [-h] [-A] [-c <value>]
7386
+
7387
+ ARGUMENTS
7388
+ FILES Space-separated list of files to stage. Paths are relative to the main project root.
7389
+
7390
+ FLAGS
7391
+ -A, --all Include all modified files.
7392
+ -c, --commit=message Commit the staged changes using the given message
7393
+ -h, --help Show CLI help.
7394
+
7395
+ DESCRIPTION
7396
+ Flags files to be included in the next commit.
7397
+ ```
7398
+
7399
+ _See code: [src/commands/stage.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/stage.ts)_
7400
+
7401
+ ## `codiac stash [FILE]`
7402
+
7403
+ describe the command here
7404
+
7405
+ ```
7406
+ USAGE
7407
+ $ codiac stash [FILE] [-h] [-n <value>] [-f]
7408
+
7409
+ FLAGS
7410
+ -f, --force
7411
+ -h, --help Show CLI help.
7412
+ -n, --name=<value> name to print
7413
+
7414
+ DESCRIPTION
7415
+ describe the command here
7416
+ ```
7417
+
7418
+ _See code: [src/commands/stash.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/stash.ts)_
7419
+
7420
+ ## `codiac status`
7421
+
7422
+ Shows the current uncommitted changes in the current branch.
7423
+
7424
+ ```
7425
+ USAGE
7426
+ $ codiac status [-h] [-s] [-u]
7427
+
7428
+ FLAGS
7429
+ -h, --help Show CLI help.
7430
+ -s, --staged Include the list of staged changes.
7431
+ -u, --unstaged Include the list of unstaged changes.
7432
+
7433
+ DESCRIPTION
7434
+ Shows the current uncommitted changes in the current branch.
7435
+ ```
7436
+
7437
+ _See code: [src/commands/status.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/status.ts)_
7438
+
7439
+ ## `codiac stop`
7440
+
7441
+ Stops the running container for this project
7442
+
7443
+ ```
7444
+ USAGE
7445
+ $ codiac stop [-h] [-r]
7446
+
7447
+ FLAGS
7448
+ -h, --help Show CLI help.
7449
+ -r, --remove Deletes the container after stopping it
7450
+
7451
+ DESCRIPTION
7452
+ Stops the running container for this project
7453
+ ```
7454
+
7455
+ _See code: [src/commands/stop.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/stop.ts)_
7456
+
7457
+ ## `codiac switch [NAME]`
7458
+
7459
+ Changes branch on the main project and any sourced dependencies.
7460
+
7461
+ ```
7462
+ USAGE
7463
+ $ codiac switch [NAME] [-h]
7464
+
7465
+ ARGUMENTS
7466
+ NAME The name of the branch to switch to (Optional: will prompt the user when missing).
7467
+
7468
+ FLAGS
7469
+ -h, --help Show CLI help.
7470
+
7471
+ DESCRIPTION
7472
+ Changes branch on the main project and any sourced dependencies.
7473
+ ```
7474
+
7475
+ _See code: [src/commands/switch.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/switch.ts)_
7476
+
7477
+ ## `codiac sync [NAME]`
7478
+
7479
+ Merges the given branch into the current branch.
7480
+
7481
+ ```
7482
+ USAGE
7483
+ $ codiac sync [NAME] -b <value> [-h] [-o] [-i]
7484
+
7485
+ ARGUMENTS
7486
+ NAME The official unique name of a currently sourced dependency. Applies the command to ONLY this sourced
7487
+ dependency.
7488
+
7489
+ FLAGS
7490
+ -b, --with=<value> (required) Branch to merge into this one
7491
+ -h, --help Show CLI help.
7492
+ -i, --includeDeps Also performs the operation on any currently source dependencies.
7493
+ -o, --only Applies the command only the sourced dependencies selected from a prompt. Quits if no dependencies
7494
+ are currently sourced.
7495
+
7496
+ DESCRIPTION
7497
+ Merges the given branch into the current branch.
7498
+ ```
7499
+
7500
+ _See code: [src/commands/sync.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/sync.ts)_
7501
+
7502
+ ## `codiac tenant create [NAME]`
7503
+
7504
+ Registers a new tenant with the current user as the administrator.
7505
+
7506
+ ```
7507
+ USAGE
7508
+ $ codiac tenant create [NAME] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
7509
+ [--withoutdefaults] [-v] [-y -n <value> -c <value>] [-h]
7510
+
7511
+ ARGUMENTS
7512
+ NAME The name of the environment to create
7513
+
7514
+ FLAGS
7515
+ -c, --code=<value> (Optional, not recommended) Proposed human readable unique identifier code for the tenant
7516
+ origanization. This command will fail if the given tenant code is already taken.
7517
+ -h, --help Show CLI help.
7518
+ -n, --name=<value> Full name of the tenant organization.
7519
+ -v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
7520
+ -y, --silent Suppresses user interaction.
7521
+ --as=<value> Fires this command with an argument list that was previously remembered using the --rememberAs
7522
+ flag.
7523
+ --remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
7524
+ --rememberAs=<value> Saves the given argument list so that it can be called by name.
7525
+ --unremember=<value> Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
7526
+ previously stored under the given name (use "--unRemember default" to clear default argument
7527
+ list memorized with the --remember flag).
7528
+ --withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
7529
+
7530
+ DESCRIPTION
7531
+ Registers a new tenant with the current user as the administrator.
7532
+ ```
7533
+
7534
+ ## `codiac tenant switch [NAME]`
7535
+
7536
+ Sets a different tenant context from the current user's list of tenants.
7537
+
7538
+ ```
7539
+ USAGE
7540
+ $ codiac tenant switch [NAME] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
7541
+ [--withoutdefaults] [-v] [-h]
7542
+
7543
+ ARGUMENTS
7544
+ NAME The name of the environment to create
7545
+
7546
+ FLAGS
7547
+ -h, --help Show CLI help.
7548
+ -v, --verbose Renders additional logging levels (detail, trace, and debug) to the console output.
7549
+ --as=<value> Fires this command with an argument list that was previously remembered using the --rememberAs
7550
+ flag.
7551
+ --remember Saves the arguments, so they are invoked as defaults whenever this command gets called.
7552
+ --rememberAs=<value> Saves the given argument list so that it can be called by name.
7553
+ --unremember=<value> Administrative only: DOES NOT fire the actual command. Simply clears the arguments that were
7554
+ previously stored under the given name (use "--unRemember default" to clear default argument
7555
+ list memorized with the --remember flag).
7556
+ --withoutdefaults Prevents any relevant saved defaults from being invoked for this call.
7557
+
7558
+ DESCRIPTION
7559
+ Sets a different tenant context from the current user's list of tenants.
7560
+ ```
7561
+
7562
+ ## `codiac token delete [NAME]`
7563
+
7564
+ Removes an identity token from storage for the current user.
7565
+
7566
+ ```
7567
+ USAGE
7568
+ $ codiac token delete [NAME] [-h]
7569
+
7570
+ ARGUMENTS
7571
+ NAME The name of the token to delete. Use the 'identity:list' command to view the currently stored tokens.
7572
+
7573
+ FLAGS
7574
+ -h, --help Displays the help document for this command.
7575
+
7576
+ DESCRIPTION
7577
+ Removes an identity token from storage for the current user.
7578
+
7579
+ ALIASES
7580
+ $ codiac identity remove
7581
+ $ codiac token delete
7582
+ $ codiac token remove
7583
+ ```
7584
+
7585
+ ## `codiac token remove [NAME]`
7586
+
7587
+ Removes an identity token from storage for the current user.
7588
+
7589
+ ```
7590
+ USAGE
7591
+ $ codiac token remove [NAME] [-h]
7592
+
7593
+ ARGUMENTS
7594
+ NAME The name of the token to delete. Use the 'identity:list' command to view the currently stored tokens.
7595
+
7596
+ FLAGS
7597
+ -h, --help Displays the help document for this command.
7598
+
7599
+ DESCRIPTION
7600
+ Removes an identity token from storage for the current user.
7601
+
7602
+ ALIASES
7603
+ $ codiac identity remove
7604
+ $ codiac token delete
7605
+ $ codiac token remove
7606
+ ```
7607
+
7608
+ ## `codiac unstage [FILES]`
7609
+
7610
+ Flags files to be included in the next commit.
7611
+
7612
+ ```
7613
+ USAGE
7614
+ $ codiac unstage [FILES] [-h] [-A]
7615
+
7616
+ ARGUMENTS
7617
+ FILES Space-separated list of files to stage. Paths are relative to the main project root.
7618
+
7619
+ FLAGS
7620
+ -A, --all Include all modified files.
7621
+ -h, --help Show CLI help.
7622
+
7623
+ DESCRIPTION
7624
+ Flags files to be included in the next commit.
7625
+ ```
7626
+
7627
+ _See code: [src/commands/unstage.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/unstage.ts)_
7628
+
7629
+ ## `codiac update [CHANNEL]`
7630
+
7631
+ update the codiac CLI
7632
+
7633
+ ```
7634
+ USAGE
7635
+ $ codiac update [CHANNEL] [-a] [-v <value> | -i] [--force]
7636
+
7637
+ FLAGS
7638
+ -a, --available Install a specific version.
7639
+ -i, --interactive Interactively select version to install. This is ignored if a channel is provided.
7640
+ -v, --version=<value> Install a specific version.
7641
+ --force Force a re-download of the requested version.
7642
+
7643
+ DESCRIPTION
7644
+ update the codiac CLI
7645
+
7646
+ EXAMPLES
7647
+ Update to the stable channel:
7648
+
7649
+ $ codiac update stable
7650
+
7651
+ Update to a specific version:
7652
+
7653
+ $ codiac update --version 1.0.0
7654
+
7655
+ Interactively select version:
7656
+
7657
+ $ codiac update --interactive
7658
+
7659
+ See available versions:
7660
+
7661
+ $ codiac update --available
7662
+ ```
7663
+
7664
+ _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v3.1.17/src/commands/update.ts)_
7665
+
7666
+ ## `codiac user login`
7667
+
7668
+ Codiac system login to authenticate user under a tenant.
7669
+
7670
+ ```
7671
+ USAGE
7672
+ $ codiac user login [-h] [-t <value>] [-o -u <value> [-i | -p <value>]] [-y ]
7673
+
7674
+ FLAGS
7675
+ -h, --help Show CLI help.
7676
+ -i, --passwordIn Reads the password directly from the standard input stream. Enables users to avoid
7677
+ explicitly rendering it in a command string. eg: `cat mypass.txt | cod login -u joecool
7678
+ --passwordIn`. Invokes `--silent` mode, so interaction will be disabled.
7679
+ -o, --tokenOut Writes the token as the sole stdout content (so that it is available to be piped or
7680
+ redirected elsewhere, eg `cod login > mycodiactoken.txt`). Leaves stdout empty on errors.
7681
+ Invokes `--silent` mode, so interaction will be disabled.
7682
+ -p, --password=<value> password on Codiac
7683
+ -t, --tenantCode=<value> Human-readable Identifier for the Codiac tenant to log in under (optional: defaults to the
7684
+ tenant code for the current project or prompts you to select one from your profile).
7685
+ -u, --username=<value> Username on Codiac
7686
+ -y, --silent (Optional: defaults to false) Prevents interactive user-interface and throws if interaction
7687
+ is needed. Requires arguments: [--username -u, --passwordIn -i]
7688
+
7689
+ DESCRIPTION
7690
+ Codiac system login to authenticate user under a tenant.
7691
+
7692
+ ALIASES
7693
+ $ codiac user login
7694
+ ```
7695
+
7696
+ ## `codiac version`
7697
+
7698
+ ```
7699
+ USAGE
7700
+ $ codiac version [--json] [--verbose]
7701
+
7702
+ FLAGS
7703
+ --verbose Show additional information about the CLI.
7704
+
7705
+ GLOBAL FLAGS
7706
+ --json Format output as json.
7707
+
7708
+ FLAG DESCRIPTIONS
7709
+ --verbose Show additional information about the CLI.
7710
+
7711
+ Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
7712
+ ```
7713
+
7714
+ _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.3.4/src/commands/version.ts)_
7715
+
7716
+ ## `codiac view dash`
7717
+
7718
+ Spins up the dashboard for a given cabinet
7719
+
7720
+ ```
7721
+ USAGE
7722
+ $ codiac view dash [-h]
7723
+
7724
+ FLAGS
7725
+ -h, --help Show CLI help.
7726
+
7727
+ DESCRIPTION
7728
+ Spins up the dashboard for a given cabinet
7729
+
7730
+ ALIASES
7731
+ $ codiac view dash
7732
+ $ codiac dash
7733
+ ```
7734
+
7735
+ ## `codiac view dashboard`
7736
+
7737
+ Spins up the dashboard for a given cabinet
7738
+
7739
+ ```
7740
+ USAGE
7741
+ $ codiac view dashboard [-h]
7742
+
7743
+ FLAGS
7744
+ -h, --help Show CLI help.
7745
+
7746
+ DESCRIPTION
7747
+ Spins up the dashboard for a given cabinet
7748
+
7749
+ ALIASES
7750
+ $ codiac view dash
7751
+ $ codiac dash
7752
+ ```
7753
+
7754
+ ## `codiac view k9s`
7755
+
7756
+ Spins up the k9s cli pod viewer
7757
+
7758
+ ```
7759
+ USAGE
7760
+ $ codiac view k9s [-h]
7761
+
7762
+ FLAGS
7763
+ -h, --help Show CLI help.
7764
+
7765
+ DESCRIPTION
7766
+ Spins up the k9s cli pod viewer
7767
+
7768
+ ALIASES
7769
+ $ codiac view k9s
7770
+ $ codiac k9s
7771
+ ```
7772
+
7773
+ ## `codiac view pods`
7774
+
7775
+ Spins up the k9s cli pod viewer
7776
+
7777
+ ```
7778
+ USAGE
7779
+ $ codiac view pods [-h]
7780
+
7781
+ FLAGS
7782
+ -h, --help Show CLI help.
7783
+
7784
+ DESCRIPTION
7785
+ Spins up the k9s cli pod viewer
7786
+
7787
+ ALIASES
7788
+ $ codiac view k9s
7789
+ $ codiac k9s
7790
+ ```
7791
+
7792
+ ## `codiac whereami [FILE]`
7793
+
7794
+ Renders the current cabinet context the image project is pointed to. ie: Tenant, Enterprise, Environment, Cabinet.
7795
+
7796
+ ```
7797
+ USAGE
7798
+ $ codiac whereami [FILE] [-h] [-n <value>] [-f]
7799
+
7800
+ FLAGS
7801
+ -f, --force
7802
+ -h, --help Show CLI help.
7803
+ -n, --name=<value> name to print
7804
+
7805
+ DESCRIPTION
7806
+ Renders the current cabinet context the image project is pointed to. ie: Tenant, Enterprise, Environment, Cabinet.
7807
+ ```
7808
+
7809
+ _See code: [src/commands/whereami.ts](https://github.com/codiac/codiac-cli/blob/v1.2.165/src/commands/whereami.ts)_
7810
+
7811
+ <!-- commandsstop -->
7812
+
4532
7813
  <!-- commandsstop -->