@facets-cloud/facetsctl

{ "version": "1.0.12", "commands": { "download-kubeconfig": { "id": "download-kubeconfig", "description": "Download your kubeconfig file for an environment. Kubeconfig can be downloaded using either an environment id or a combination of blueprint name and environment name.", "strict": true, "pluginName": "@facets-cloud/facetsctl", "pluginAlias": "@facets-cloud/facetsctl", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "environment-id": { "name": "environment-id", "type": "option", "char": "e", "description": "Environment id for downloading kubeconfig", "multiple": false, "exclusive": [ "environment-name", "blueprint-name" ] }, "environment-name": { "name": "environment-name", "type": "option", "description": "Environment name for downloading kubeconfig", "multiple": false, "dependsOn": [ "blueprint-name" ], "exclusive": [ "environment-id" ] }, "blueprint-name": { "name": "blueprint-name", "type": "option", "description": "Blueprint name using which environment was launched", "multiple": false, "dependsOn": [ "environment-name" ], "exclusive": [ "environment-id" ] } }, "args": {} }, "generate-config": { "id": "generate-config", "description": "Convert a JSON, YAML, or properties file of a springboot application to a Facets Application JSON env section", "strict": true, "pluginName": "@facets-cloud/facetsctl", "pluginAlias": "@facets-cloud/facetsctl", "pluginType": "core", "aliases": [], "hiddenAliases": [], "flags": {}, "args": { "config-file": { "name": "config-file", "description": "The JSON, YAML, or properties file to convert", "required": true } } }, "login": { "id": "login", "description": "Login to Facets control plane", "strict": true, "pluginName": "@facets-cloud/facetsctl", "pluginAlias": "@facets-cloud/facetsctl", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "username": { "name": "username", "type": "option", "char": "u", "description": "username of the user", "required": true, "multiple": false }, "access-token": { "name": "access-token", "type": "option", "char": "t", "description": "Personal token generated for the user", "required": true, "multiple": false }, "cp-url": { "name": "cp-url", "type": "option", "char": "c", "description": "URL of the Control plane", "required": true, "multiple": false }, "debug": { "name": "debug", "type": "option", "description": "See original error message thrown", "required": false, "multiple": false, "default": "false" } }, "args": {} }, "push": { "id": "push", "description": "Post new docker artifacts to the facets control plane", "strict": true, "pluginName": "@facets-cloud/facetsctl", "pluginAlias": "@facets-cloud/facetsctl", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "docker-image": { "name": "docker-image", "type": "option", "char": "i", "description": "image location <IMAGE:TAG>", "required": true, "multiple": false }, "artifact-name": { "name": "artifact-name", "type": "option", "char": "a", "description": "name of the artifact as mentioned in blueprint", "required": true, "multiple": false }, "registration-type": { "name": "registration-type", "type": "option", "description": "mode of registration", "required": false, "multiple": false, "options": [ "CLUSTER", "RELEASE_STREAM" ] }, "registration-value": { "name": "registration-value", "type": "option", "description": "value for release stream or cluster id, based on mode of registration", "required": false, "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "description of the build if any", "required": false, "multiple": false }, "external-id": { "name": "external-id", "type": "option", "char": "e", "description": "external identifier for artifact", "required": true, "multiple": false }, "artifactory": { "name": "artifactory", "type": "option", "description": "artifactory where image will be pushed", "required": false, "multiple": false }, "debug": { "name": "debug", "type": "option", "description": "See original error message thrown", "required": false, "multiple": false, "default": "false" }, "git-ref": { "name": "git-ref", "type": "option", "description": "Git ref provided in CI Rule", "required": false, "multiple": false } }, "args": {} }, "refresh": { "id": "refresh", "description": "Refresh your k8s credentials for an environment. Credentials can be refreshed using either an environment id or a combination of blueprint name and environment name.", "strict": true, "pluginName": "@facets-cloud/facetsctl", "pluginAlias": "@facets-cloud/facetsctl", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "environment-id": { "name": "environment-id", "type": "option", "char": "e", "description": "Environment id for credentials needs to be refreshed", "multiple": false, "exclusive": [ "environment-name", "blueprint-name" ] }, "environment-name": { "name": "environment-name", "type": "option", "description": "Environment Name for credentials needs to be refreshed", "multiple": false, "dependsOn": [ "blueprint-name" ], "exclusive": [ "environment-id" ] }, "blueprint-name": { "name": "blueprint-name", "type": "option", "description": "Blueprint name using which environment was launched", "multiple": false, "dependsOn": [ "environment-name" ], "exclusive": [ "environment-id" ] } }, "args": {} }, "register-by-env": { "id": "register-by-env", "description": "Register already pushed images from external repository to facets control plane through environment name.", "strict": true, "pluginName": "@facets-cloud/facetsctl", "pluginAlias": "@facets-cloud/facetsctl", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "docker-image": { "name": "docker-image", "type": "option", "char": "i", "description": "docker image URL in the external registry", "required": true, "multiple": false }, "service": { "name": "service", "type": "option", "char": "s", "description": "name of the CI integration for which the artifact needs to be registered", "required": true, "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "description of the build if any", "required": false, "multiple": false }, "external-id": { "name": "external-id", "type": "option", "char": "e", "description": "external identifier for artifact", "required": true, "multiple": false }, "registry": { "name": "registry", "type": "option", "description": "artifactory where image will be pushed", "required": false, "multiple": false }, "environment-name": { "name": "environment-name", "type": "option", "description": "environment name in which the artifact will be registered", "multiple": false, "dependsOn": [ "blueprint-name" ], "exclusive": [ "environment-id" ] }, "blueprint-name": { "name": "blueprint-name", "type": "option", "description": "blueprint name in which given environment is present", "multiple": false, "dependsOn": [ "environment-name" ], "exclusive": [ "environment-id" ] }, "environment-id": { "name": "environment-id", "type": "option", "description": "environment id in which the artifact will be registered", "multiple": false, "exclusive": [ "environment-name", "blueprint-name" ] }, "debug": { "name": "debug", "type": "option", "description": "see original error message thrown", "required": false, "multiple": false, "default": "false" } }, "args": {} }, "register-by-release-stream": { "id": "register-by-release-stream", "description": "Register already pushed images from external repository to facets control plane through release stream.", "strict": true, "pluginName": "@facets-cloud/facetsctl", "pluginAlias": "@facets-cloud/facetsctl", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "docker-image": { "name": "docker-image", "type": "option", "char": "i", "description": "docker image URL in the external registry", "required": true, "multiple": false }, "service": { "name": "service", "type": "option", "char": "s", "description": "name of the CI integration for which the artifact needs to be registered", "required": true, "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "description of the build if any", "required": false, "multiple": false }, "external-id": { "name": "external-id", "type": "option", "char": "e", "description": "external identifier for artifact", "required": true, "multiple": false }, "registry": { "name": "registry", "type": "option", "description": "artifactory where image will be pushed", "required": false, "multiple": false }, "release-stream": { "name": "release-stream", "type": "option", "description": "name of the release stream", "required": true, "multiple": false }, "blueprint-name": { "name": "blueprint-name", "type": "option", "description": "blueprint name in which CI Integration will be created if not present already", "required": false, "multiple": false }, "debug": { "name": "debug", "type": "option", "description": "see original error message thrown", "required": false, "multiple": false, "default": "false" } }, "args": {} }, "register": { "id": "register", "description": "Register already pushed images from external repository to facets control plane", "strict": true, "pluginName": "@facets-cloud/facetsctl", "pluginAlias": "@facets-cloud/facetsctl", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "docker-image": { "name": "docker-image", "type": "option", "char": "i", "description": "docker image URL in the external registry", "required": true, "multiple": false }, "service": { "name": "service", "type": "option", "char": "s", "description": "name of the CI integration for which the artifact needs to be registered", "required": true, "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "description of the build if any", "required": false, "multiple": false }, "external-id": { "name": "external-id", "type": "option", "char": "e", "description": "external identifier for artifact", "required": true, "multiple": false }, "registry": { "name": "registry", "type": "option", "description": "artifactory where image will be pushed", "required": false, "multiple": false }, "git-ref": { "name": "git-ref", "type": "option", "description": "git ref provided in CI Rule", "required": true, "multiple": false }, "registration-type": { "name": "registration-type", "type": "option", "description": "mode of registration for CI integration", "required": false, "multiple": false, "options": [ "ENVIRONMENT", "RELEASE_STREAM" ] }, "blueprint-name": { "name": "blueprint-name", "type": "option", "description": "blueprint name in which CI Integration will be created if not present already", "required": false, "multiple": false }, "debug": { "name": "debug", "type": "option", "description": "see original error message thrown", "required": false, "multiple": false, "default": "false" } }, "args": {} }, "upload": { "id": "upload", "description": "Upload any type of application build file to the Facets Control Plane", "strict": true, "pluginName": "@facets-cloud/facetsctl", "pluginAlias": "@facets-cloud/facetsctl", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "file-path": { "name": "file-path", "type": "option", "char": "p", "description": "path to the application build file (e.g., WAR, JAR, ZIP) on your local system", "required": true, "multiple": false }, "artifact-name": { "name": "artifact-name", "type": "option", "char": "a", "description": "name of the artifact-ci as mentioned in resource spec. If the CI integration is already created, provide its name. If not, additionally provide blueprint name and the registration type using respective flags.'", "required": true, "multiple": false }, "registration-type": { "name": "registration-type", "type": "option", "description": "mode of registration", "required": false, "multiple": false, "options": [ "ENVIRONMENT", "RELEASE_STREAM" ] }, "registration-value": { "name": "registration-value", "type": "option", "description": "value for release stream or cluster id, based on mode of registration", "required": false, "multiple": false }, "git-ref": { "name": "git-ref", "type": "option", "description": "Git ref provided in CI Rule", "required": false, "multiple": false }, "blueprint-name": { "name": "blueprint-name", "type": "option", "description": "name of the blueprint where the CI integration will be created.", "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "description of the build if any", "required": false, "multiple": false }, "external-id": { "name": "external-id", "type": "option", "char": "e", "description": "external identifier for CI Integration", "required": true, "multiple": false }, "debug": { "name": "debug", "type": "option", "description": "See original error message thrown", "required": false, "multiple": false, "default": "false" } }, "args": {} } } }