@facets-cloud/facetsctlv3/oclif.manifest.json

Facets CLI

{
  "commands": {
    "login": {
      "aliases": [],
      "args": {},
      "description": "Log in to the Facets control plane",
      "examples": [
        "$ facetsctl login --username my-user --token my-token --facets-url https://facets-control-plane.example.com\nLogged in successfully\n"
      ],
      "flags": {
        "username": {
          "char": "u",
          "description": "Username",
          "name": "username",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "token": {
          "char": "t",
          "description": "Personal token",
          "name": "token",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "facets-url": {
          "char": "f",
          "description": "URL of the Control plane",
          "name": "facets-url",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "login",
      "pluginAlias": "@facets-cloud/facetsctlv3",
      "pluginName": "@facets-cloud/facetsctlv3",
      "pluginType": "core",
      "strict": true,
      "enableJsonFlag": false,
      "isESM": false,
      "relativePath": [
        "dist",
        "src",
        "commands",
        "login.js"
      ]
    },
    "artifact:init": {
      "aliases": [],
      "args": {},
      "description": "Initialize artifact information",
      "examples": [
        "$ facetsctl artifact init --project my-project --service my-service --artifactory my-artifactory\nCreated artifact-info.facets.yaml\n"
      ],
      "flags": {
        "project": {
          "char": "p",
          "description": "Project name",
          "name": "project",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "service": {
          "char": "s",
          "description": "Service name",
          "exclusive": [
            "ci-integration"
          ],
          "name": "service",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "ci-integration": {
          "char": "c",
          "description": "CI Integration Name",
          "exclusive": [
            "service"
          ],
          "name": "ci-integration",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "artifactory": {
          "char": "a",
          "description": "Artifactory name",
          "name": "artifactory",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "artifact:init",
      "pluginAlias": "@facets-cloud/facetsctlv3",
      "pluginName": "@facets-cloud/facetsctlv3",
      "pluginType": "core",
      "strict": true,
      "enableJsonFlag": false,
      "isESM": false,
      "relativePath": [
        "dist",
        "src",
        "commands",
        "artifact",
        "init.js"
      ]
    },
    "artifact:push": {
      "aliases": [],
      "args": {},
      "description": "Push a Docker image to the configured artifact repository",
      "examples": [
        "$ facetsctl artifact push --docker-image my-docker-image:latest\nSuccessfully pushed my-docker-image:latest\n"
      ],
      "flags": {
        "docker-image": {
          "char": "d",
          "description": "URL of the Docker image to push",
          "name": "docker-image",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "artifact:push",
      "pluginAlias": "@facets-cloud/facetsctlv3",
      "pluginName": "@facets-cloud/facetsctlv3",
      "pluginType": "core",
      "strict": true,
      "enableJsonFlag": false,
      "isESM": false,
      "relativePath": [
        "dist",
        "src",
        "commands",
        "artifact",
        "push.js"
      ]
    },
    "artifact:register": {
      "aliases": [],
      "args": {},
      "description": "Register a Docker image with a specified type and value",
      "examples": [
        "$ facetsctl artifact register --type GIT_REF --docker-image my-docker-image:latest --value my-git-ref\nSuccessfully registered my-docker-image:latest\nCheck out the registered build at: https://example.com/builds/1234\n"
      ],
      "flags": {
        "type": {
          "char": "t",
          "description": "Type (GIT_REF, ENVIRONMENT, RELEASE_STREAM)",
          "name": "type",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "options": [
            "GIT_REF",
            "ENVIRONMENT",
            "RELEASE_STREAM"
          ],
          "type": "option"
        },
        "docker-image": {
          "char": "i",
          "description": "Docker image to register",
          "name": "docker-image",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "value": {
          "char": "v",
          "description": "Value of the specified type",
          "name": "value",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "runId": {
          "char": "r",
          "description": "Optional run ID to corelate to your CI system, else it will be time",
          "name": "runId",
          "required": false,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "artifact:register",
      "pluginAlias": "@facets-cloud/facetsctlv3",
      "pluginName": "@facets-cloud/facetsctlv3",
      "pluginType": "core",
      "strict": true,
      "enableJsonFlag": false,
      "isESM": false,
      "relativePath": [
        "dist",
        "src",
        "commands",
        "artifact",
        "register.js"
      ]
    },
    "artifact:upload": {
      "aliases": [],
      "args": {},
      "description": "Upload any type of application build file to the Facets Control Plane",
      "examples": [
        "$ facetsctl artifact upload --type GIT_REF --file-path file-to-upload --value my-git-ref\n      Successfully uploaded the file file-to-upload\n      Check out the registered build at: https://example.com/builds/1234\n    "
      ],
      "flags": {
        "type": {
          "char": "t",
          "description": "Type (GIT_REF, ENVIRONMENT, RELEASE_STREAM)",
          "name": "type",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "options": [
            "GIT_REF",
            "ENVIRONMENT",
            "RELEASE_STREAM"
          ],
          "type": "option"
        },
        "file-path": {
          "char": "f",
          "description": "path to the application build file (e.g., WAR, JAR, ZIP) on your local system",
          "name": "file-path",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "value": {
          "char": "v",
          "description": "Value of the specified type",
          "name": "value",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "runId": {
          "char": "r",
          "description": "Optional run ID to corelate to your CI system, else it will be time",
          "name": "runId",
          "required": false,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "artifact:upload",
      "pluginAlias": "@facets-cloud/facetsctlv3",
      "pluginName": "@facets-cloud/facetsctlv3",
      "pluginType": "core",
      "strict": true,
      "enableJsonFlag": false,
      "isESM": false,
      "relativePath": [
        "dist",
        "src",
        "commands",
        "artifact",
        "upload.js"
      ]
    },
    "release:sync": {
      "aliases": [],
      "args": {
        "apps": {
          "description": "List of app names to sync (comma-separated | example: ... sync app1,app2,app3 -p ...)",
          "name": "apps",
          "required": true
        }
      },
      "description": "Sync out-of-sync apps to match their desired state with the deployed state",
      "flags": {
        "project": {
          "char": "p",
          "description": "Project name",
          "name": "project",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "environment": {
          "char": "e",
          "description": "Environment name",
          "name": "environment",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "release:sync",
      "pluginAlias": "@facets-cloud/facetsctlv3",
      "pluginName": "@facets-cloud/facetsctlv3",
      "pluginType": "core",
      "strict": true,
      "enableJsonFlag": false,
      "isESM": false,
      "relativePath": [
        "dist",
        "src",
        "commands",
        "release",
        "sync.js"
      ]
    },
    "release:wait": {
      "aliases": [],
      "args": {
        "apps": {
          "description": "List of app names to wait for (comma-separated | example: ... sync app1,app2,app3 -p ...)",
          "name": "apps",
          "required": true
        }
      },
      "description": "Wait for the sync status of the specified apps, and trigger sync if --sync is provided",
      "flags": {
        "project": {
          "char": "p",
          "description": "Project name",
          "name": "project",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "environment": {
          "char": "e",
          "description": "Environment name",
          "name": "environment",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "sync": {
          "description": "Trigger a sync if apps are out-of-sync",
          "name": "sync",
          "allowNo": false,
          "type": "boolean"
        },
        "debug": {
          "description": "To check API response for each resource",
          "hidden": true,
          "name": "debug",
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "release:wait",
      "pluginAlias": "@facets-cloud/facetsctlv3",
      "pluginName": "@facets-cloud/facetsctlv3",
      "pluginType": "core",
      "strict": true,
      "usage": "facetsctl release wait <apps> -p <value> -e <value> [--sync]",
      "enableJsonFlag": false,
      "isESM": false,
      "relativePath": [
        "dist",
        "src",
        "commands",
        "release",
        "wait.js"
      ]
    }
  },
  "version": "1.1.5"
}