@constructor-io/constructorio-connect-cli/oclif.manifest.json

CLI tool to enable users to interface with the Constructor Connect Ecosystem

{
  "commands": {
    "deploy": {
      "aliases": [],
      "args": {
        "env": {
          "description": "The target Constructor environment to deploy to.",
          "name": "env",
          "options": [
            "development",
            "qa",
            "production",
            "demo"
          ],
          "required": true
        }
      },
      "description": "Deploys all templates defined on the `connectrc.js` file to the specified environment, after running tests ('--force' to skip). \n\nThe script will use the `CONNECT_AUTH_TOKEN` environment variable to authenticate with Constructor.",
      "examples": [
        "$ <%= config.bin %> deploy development",
        "$ <%= config.bin %> deploy qa",
        "$ <%= config.bin %> deploy production",
        "$ <%= config.bin %> deploy production --force"
      ],
      "flags": {
        "force": {
          "char": "f",
          "description": "Skip tests before deploying",
          "name": "force",
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "deploy",
      "pluginAlias": "@constructor-io/constructorio-connect-cli",
      "pluginName": "@constructor-io/constructorio-connect-cli",
      "pluginType": "core",
      "strict": true,
      "enableJsonFlag": false,
      "isESM": false,
      "relativePath": [
        "dist",
        "commands",
        "deploy.js"
      ]
    },
    "execute": {
      "aliases": [],
      "args": {},
      "description": "Execute a template against a connection and fixture to see the resulting transformed data. Each value not provided as a flag will be prompted for when the command is executed.",
      "examples": [
        "$ <%= config.bin %> execute",
        "$ <%= config.bin %> execute --template-path=item/item.jsonata",
        "$ <%= config.bin %> execute --template-path=variation/variation.jsonata",
        "$ <%= config.bin %> execute --template-path=item_group/item_group.jsonata --fixture-path=item_group.json",
        "$ <%= config.bin %> execute --template-path=grouping/grouping.jsonata --connection-id=example-connection-id",
        "$ <%= config.bin %> execute --template-path=mapping/mapping.jsonata"
      ],
      "flags": {
        "template-path": {
          "description": "The path to the template to execute. Must be in the 'src/templates' directory.",
          "name": "template-path",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "fixture-path": {
          "description": "The path to the fixture to execute the template against. Must be in the 'src/fixtures' directory.",
          "name": "fixture-path",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "external-data-path": {
          "description": "The path to the external data to execute the template against. Must be in the 'src/fixtures/external_data' directory.",
          "name": "external-data-path",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "connection-id": {
          "description": "The ID of the connection to execute the template against.",
          "name": "connection-id",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "override-date": {
          "description": "Date with which to override $now and $millis in the template.",
          "name": "override-date",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "execute",
      "pluginAlias": "@constructor-io/constructorio-connect-cli",
      "pluginName": "@constructor-io/constructorio-connect-cli",
      "pluginType": "core",
      "strict": true,
      "enableJsonFlag": false,
      "isESM": false,
      "relativePath": [
        "dist",
        "commands",
        "execute.js"
      ]
    },
    "generate-fixture": {
      "aliases": [],
      "args": {},
      "description": "This command will fetch one fixture from the server and save it into a specified file. This fixture file will be an example of how the data would be passed to the connector when executing the templates.\n You are expected to customize this file to match the data you expect to cover in a template execution (e.g. an item with stock, a variation with missing data), etc. Note that you can have multiple fixtures of the same type to cover different scenarios.\n Finally, if the file already exists you'll be prompted to overwrite it.",
      "examples": [
        "$ <%= config.bin %> generate-fixture"
      ],
      "flags": {},
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "generate-fixture",
      "pluginAlias": "@constructor-io/constructorio-connect-cli",
      "pluginName": "@constructor-io/constructorio-connect-cli",
      "pluginType": "core",
      "strict": true,
      "enableJsonFlag": false,
      "isESM": false,
      "relativePath": [
        "dist",
        "commands",
        "generate-fixture.js"
      ]
    },
    "init": {
      "aliases": [],
      "args": {
        "name": {
          "description": "name of the new folder",
          "name": "name",
          "required": true
        }
      },
      "description": "Bootstrap a new Constructor.io Connect CLI repository.",
      "examples": [
        "<%= config.bin %> <%= command.id %>",
        "<%= config.bin %> <%= command.id %> new-repo-name"
      ],
      "flags": {},
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "init",
      "pluginAlias": "@constructor-io/constructorio-connect-cli",
      "pluginName": "@constructor-io/constructorio-connect-cli",
      "pluginType": "core",
      "strict": true,
      "enableJsonFlag": false,
      "isESM": false,
      "relativePath": [
        "dist",
        "commands",
        "init.js"
      ]
    },
    "refresh-connections": {
      "aliases": [],
      "args": {},
      "description": "Refresh the connections list",
      "flags": {},
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "refresh-connections",
      "pluginAlias": "@constructor-io/constructorio-connect-cli",
      "pluginName": "@constructor-io/constructorio-connect-cli",
      "pluginType": "core",
      "strict": true,
      "enableJsonFlag": false,
      "isESM": false,
      "relativePath": [
        "dist",
        "commands",
        "refresh-connections.js"
      ]
    },
    "trigger-catalog-sync": {
      "aliases": [],
      "args": {},
      "description": "Triggers a catalog sync for selected connection. \n\nThe script will use the `CONNECT_AUTH_TOKEN` environment variable to authenticate with Constructor.",
      "examples": [
        "$ <%= config.bin %>"
      ],
      "flags": {},
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "trigger-catalog-sync",
      "pluginAlias": "@constructor-io/constructorio-connect-cli",
      "pluginName": "@constructor-io/constructorio-connect-cli",
      "pluginType": "core",
      "strict": true,
      "enableJsonFlag": false,
      "isESM": false,
      "relativePath": [
        "dist",
        "commands",
        "trigger-catalog-sync.js"
      ]
    }
  },
  "version": "1.16.1"
}