@codiac.io/codiac-cli 1.2.157 → 1.2.164

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