@codiac.io/codiac-cli 1.2.157 → 1.2.165

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