@codiac.io/codiac-cli 1.3.63 → 1.3.64

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.63",
+  "version": "1.3.64",
   "commands": {
     "branch": {
       "id": "branch",
@@ -1650,7 +1650,7 @@
           "name": "enterprise",
           "type": "option",
           "char": "e",
-          "description": "The name of the enterprise in which this asset resides. (defaults to the current enterprise context)",
+          "description": "The name of the enterprise in which this asset resides. (defaults to the current enterprise context).  NOTE: The enterprise assignment for an asset is immutable and cannot be modified; this flag is used only for identifying the asset.",
           "required": false,
           "multiple": false
         },
@@ -1658,7 +1658,7 @@
           "name": "name",
           "type": "option",
           "char": "n",
-          "description": "The name of the asset to edit.",
+          "description": "The name of the asset to edit.  NOTE: The asset name is immutable and cannot be modified; this flag is used only for identifying the asset.",
           "required": false,
           "multiple": false
         },
@@ -5942,6 +5942,212 @@
         }
       }
     },
+    "asset:entrypoint:delete": {
+      "id": "asset:entrypoint:delete",
+      "description": "Removes an existing override of the image startup command for this asset (restores the original ENTRYPOINT set in the image itself, as well as any image elements specified using CMD)).",
+      "strict": true,
+      "pluginName": "@codiac.io/codiac-cli",
+      "pluginAlias": "@codiac.io/codiac-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "hiddenAliases": [],
+      "examples": [
+        {
+          "description": "Interactive",
+          "command": "<%= config.bin %> <%= command.id %>"
+        },
+        {
+          "description": "Interactive, preset for the a specific asset.",
+          "command": "<%= config.bin %> <%= command.id %> -a my-api"
+        },
+        {
+          "description": "Interactive as above, but when you have more than a single enterprise, and one of them is named `ml`.",
+          "command": "<%= config.bin %> <%= command.id %> -e ml -a my-worker"
+        },
+        {
+          "description": "Non-interactive, removal by specifying the version range with an explicit match",
+          "command": "<%= config.bin %> <%= command.id %> -e ml -a my-worker -v '>=1.2.3' --silent"
+        }
+      ],
+      "flags": {
+        "enterprise": {
+          "name": "enterprise",
+          "type": "option",
+          "char": "e",
+          "description": "The name of the enterprise in which this asset resides (defaults to the current enterprise context).",
+          "required": false,
+          "multiple": false
+        },
+        "asset": {
+          "name": "asset",
+          "type": "option",
+          "char": "a",
+          "description": "The name of the asset to adjust.",
+          "required": false,
+          "multiple": false
+        },
+        "version-range": {
+          "name": "version-range",
+          "type": "option",
+          "char": "v",
+          "description": "(optional, defaults to the entrypoint assigned to \"any\" version) Used to identify the entrypoint.  The semantic version rule describing which versions of the asset will get this entrypoint applied.  (eg: Just this one: `1.2.3`, or this one and any future patches: `^1.2.3`, or any on or after this one: `>=1.2.3`, or any before this one `<1.2.3` , or any between inclusive: `1.0.0 - 1.2.3`).  NOTE: Remember to wrap your range spec in quotes if it has any spaces in it.",
+          "required": false,
+          "multiple": false
+        },
+        "silent": {
+          "name": "silent",
+          "type": "boolean",
+          "description": "Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.",
+          "allowNo": false,
+          "dependsOn": [
+            "asset"
+          ],
+          "exclusive": [
+            "echo",
+            "to-script"
+          ]
+        },
+        "echo": {
+          "name": "echo",
+          "type": "boolean",
+          "description": "Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.",
+          "allowNo": false,
+          "exclusive": [
+            "to-script",
+            "silent"
+          ]
+        },
+        "to-script": {
+          "name": "to-script",
+          "type": "boolean",
+          "description": "Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.",
+          "allowNo": false,
+          "exclusive": [
+            "echo",
+            "silent"
+          ]
+        }
+      },
+      "args": {}
+    },
+    "asset:entrypoint:set": {
+      "id": "asset:entrypoint:set",
+      "description": "Sets the command run on container startup (Overrides the ENTRYPOINT set in the image itself, as well as any image elements specified using CMD)).",
+      "strict": true,
+      "pluginName": "@codiac.io/codiac-cli",
+      "pluginAlias": "@codiac.io/codiac-cli",
+      "pluginType": "core",
+      "aliases": [
+        "asset:entrypoint"
+      ],
+      "hiddenAliases": [],
+      "examples": [
+        {
+          "description": "Interactive",
+          "command": "<%= config.bin %> <%= command.id %>"
+        },
+        {
+          "description": "Interactive, preset for the a specific asset.",
+          "command": "<%= config.bin %> <%= command.id %> -a my-api"
+        },
+        {
+          "description": "Interactive as above, but when you have more than a single enterprise, and one of them is named `ml`.",
+          "command": "<%= config.bin %> <%= command.id %> -e ml -a my-worker"
+        },
+        {
+          "description": "Invoking an executable from within a bash shell (this mock scenario just imports some credentials and workflows and once complete, the image shuts down)",
+          "command": "<%= config.bin %> <%= command.id %> -a my-import --command '/bin/sh' --arg '-c'         --arg 'myexe import:credentials --separate --input=/backup/credentials && myexe import:workflow --separate --input=/backup/workflows'"
+        },
+        {
+          "description": "Same as above but non-interactive (for use in scripts and pipelines)",
+          "command": "<%= config.bin %> <%= command.id %> --silent -e ml -a my-import --command '/bin/sh' --arg '-c'         --arg 'myexe import:credentials --separate --input=/backup/credentials && myexe import:workflow --separate --input=/backup/workflows'"
+        }
+      ],
+      "flags": {
+        "enterprise": {
+          "name": "enterprise",
+          "type": "option",
+          "char": "e",
+          "description": "The name of the enterprise in which this asset resides. (defaults to the current enterprise context).  NOTE: The enterprise assignment for an asset is immutable and cannot be modified; this flag is used only for identifying the asset.",
+          "required": false,
+          "multiple": false
+        },
+        "asset": {
+          "name": "asset",
+          "type": "option",
+          "char": "a",
+          "description": "The name of the asset to edit.  NOTE: The asset name is immutable and cannot be modified; this flag is used only for identifying the asset.",
+          "required": false,
+          "multiple": false
+        },
+        "workdir": {
+          "name": "workdir",
+          "type": "option",
+          "char": "d",
+          "description": "(optional) Folder path within the image from which to execute the command. Overrides the default working directory specified by the container image.",
+          "required": false,
+          "multiple": false
+        },
+        "command": {
+          "name": "command",
+          "type": "option",
+          "char": "c",
+          "description": "The command to run.  Not executed within a shell.",
+          "required": false,
+          "multiple": false
+        },
+        "arg": {
+          "name": "arg",
+          "type": "option",
+          "char": "c",
+          "description": "Gets passed to the entryPointCommand.  Often, the entrypointCommand opens a shell, allowing this to be the command to run inside the shell,       eg: `--command=\"/bin/sh\" --arg=\"-c ls -a\"` which yields: `/bin/sh -c ls -a`",
+          "required": false,
+          "multiple": true
+        },
+        "version-range": {
+          "name": "version-range",
+          "type": "option",
+          "char": "v",
+          "description": "(optional) The semantic version rule describing which versions of the asset will get this entrypoint applied.  (eg: Just this one: `1.2.3`, or this one and any future patches: `^1.2.3`, or any on or after this one: `>=1.2.3`, or any before this one `<1.2.3` , or any between inclusive: `1.0.0 - 1.2.3`).  NOTE: Remember to wrap your range spec in quotes if it has any spaces in it.",
+          "required": false,
+          "multiple": false
+        },
+        "silent": {
+          "name": "silent",
+          "type": "boolean",
+          "description": "Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.",
+          "allowNo": false,
+          "dependsOn": [
+            "asset"
+          ],
+          "exclusive": [
+            "echo",
+            "to-script"
+          ]
+        },
+        "echo": {
+          "name": "echo",
+          "type": "boolean",
+          "description": "Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.",
+          "allowNo": false,
+          "exclusive": [
+            "to-script",
+            "silent"
+          ]
+        },
+        "to-script": {
+          "name": "to-script",
+          "type": "boolean",
+          "description": "Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.",
+          "allowNo": false,
+          "exclusive": [
+            "echo",
+            "silent"
+          ]
+        }
+      },
+      "args": {}
+    },
     "asset:probe:create": {
       "id": "asset:probe:create",
       "description": "Declares the implementation of a health or readiness probe for an asset.",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codiac.io/codiac-cli",
   "description": "Local command line interface for managing enterprise assets and environments. ",
-  "version": "1.3.63",
+  "version": "1.3.64",
   "author": "Codiac",
   "bin": {
     "codiac": "./bin/run",