@unito/integration-cli

{ "commands": { "activity": { "aliases": [], "args": {}, "description": "Show the activity associated with your integration", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "number": { "char": "n", "description": "Limit the number of events to show. Must be less than or equal to 1000. Default is 1000.\n\n Usage: <%= config.bin %> <%= command.id %> --number=10", "name": "number", "summary": "number of events to show", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "description": "the environment of the platform", "name": "environment", "default": "production", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "staging", "production" ], "type": "option" }, "follow": { "char": "f", "description": "Follow the activity of your integration. This will keep the command running and will show new events as they are created.\n\n Usage: <%= config.bin %> <%= command.id %> --follow", "name": "follow", "summary": "follow the activity", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "activity", "pluginAlias": "@unito/integration-cli", "pluginName": "@unito/integration-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": false, "relativePath": [ "dist", "src", "commands", "activity.js" ] }, "dev": { "aliases": [], "args": {}, "description": "Develop your integration", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "environment": { "description": "the environment of the platform", "name": "environment", "default": "production", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "staging", "production" ], "type": "option" }, "verbose": { "description": "output more (debug) information", "name": "verbose", "allowNo": false, "type": "boolean" }, "credential-payload": { "description": "(advanced) credential payload to use.", "exclusive": [ "credential-id" ], "name": "credential-payload", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "credential-id": { "description": "(advanced) credential to use.", "exclusive": [ "credential-payload" ], "name": "credential-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "test-account": { "description": "test account to use.", "name": "test-account", "default": "development", "hasDynamicHelp": false, "multiple": false, "options": [ "development", "compliance" ], "type": "option" }, "read-only": { "description": "whether or not to only perform read operations", "name": "read-only", "allowNo": true, "type": "boolean" }, "timeout": { "description": "timeout in seconds passed as 'X-Unito-Operation-Deadline' header to the integration. Set to 0 for no timeout.", "name": "timeout", "default": 0, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "crawlMode": { "description": "mode to use while crawling the integration graph", "name": "crawlMode", "default": "full", "hasDynamicHelp": false, "multiple": false, "options": [ "full", "sample", "single" ], "type": "option" }, "checks": { "description": "checks to perform while crawling the integration graph", "name": "checks", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "config-path": { "description": "Use a custom configuration file instead of the default '.unito.json' or other environment specific\n ones.\n\n If you want to force the CLI to use a specific configuration file, you can use this flag to specify the relative\n path from your integration's root folder (with a leading '/').\n\n Usage: <%= config.bin %> <%= command.id %> --config-path=/myCustomConfig.json", "name": "config-path", "summary": "relative path to a custom \".unito.json\" file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "skip-install": { "description": "whether or not to run npm install before starting the integration", "name": "skip-install", "allowNo": true, "type": "boolean" }, "port": { "description": "port to run the integration on", "name": "port", "default": 9200, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "dev", "pluginAlias": "@unito/integration-cli", "pluginName": "@unito/integration-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": false, "relativePath": [ "dist", "src", "commands", "dev.js" ] }, "encrypt": { "aliases": [], "args": {}, "description": "Encrypt data", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "environment": { "description": "the environment of the platform", "name": "environment", "default": "production", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "staging", "production" ], "type": "option" }, "sensitive": { "description": "once encrypted, sensitive data cannot be decrypted", "name": "sensitive", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "encrypt", "pluginAlias": "@unito/integration-cli", "pluginName": "@unito/integration-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": false, "relativePath": [ "dist", "src", "commands", "encrypt.js" ] }, "init": { "aliases": [], "args": {}, "description": "Initialize a new integration", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --name pokemon" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "name": { "char": "n", "description": "Name of the integration", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "init", "pluginAlias": "@unito/integration-cli", "pluginName": "@unito/integration-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": false, "relativePath": [ "dist", "src", "commands", "init.js" ] }, "invite": { "aliases": [], "args": {}, "description": "Invite a user to become a developer of your integration", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "environment": { "description": "the environment of the platform", "name": "environment", "default": "production", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "staging", "production" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "invite", "pluginAlias": "@unito/integration-cli", "pluginName": "@unito/integration-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": false, "relativePath": [ "dist", "src", "commands", "invite.js" ] }, "login": { "aliases": [], "args": {}, "description": "Login to the Integrations Platform", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "environment": { "description": "the environment of the platform", "name": "environment", "default": "production", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "staging", "production" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "login", "pluginAlias": "@unito/integration-cli", "pluginName": "@unito/integration-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": false, "relativePath": [ "dist", "src", "commands", "login.js" ] }, "oauth2": { "aliases": [], "args": {}, "description": "The Oauth2 command allows you to perform an OAuth2 workflow to populate the specified test account's accessToken and refreshToken to be used by the 'test' and 'dev' commands.\n\n If the test-account is already populated, the command will refresh the credentials if the refresh token is available.\n If you want to force a new OAuth2 flow to change the connected account or something else, use the --reauth flag.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --reauth --test-account=compliance" ], "flags": { "test-account": { "description": "Test account to use.", "name": "test-account", "default": "development", "hasDynamicHelp": false, "multiple": false, "options": [ "development", "compliance" ], "type": "option" }, "environment": { "description": "the environment of the platform", "hidden": true, "name": "environment", "default": "production", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "staging", "production" ], "type": "option" }, "reauth": { "description": "triggers a new oauth2 flow to overwrite the test account's current credentials", "name": "reauth", "allowNo": false, "type": "boolean" }, "config-path": { "description": "Use a custom configuration file instead of the default '.unito.json' or other environment specific\n ones.\n\n If you want to force the CLI to use a specific configuration file, you can use this flag to specify the relative\n path from your integration's root folder (with a leading '/').\n\n Usage: <%= config.bin %> <%= command.id %> --config-path=/myCustomConfig.json", "name": "config-path", "summary": "relative path to a custom \".unito.json\" file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "oauth2", "pluginAlias": "@unito/integration-cli", "pluginName": "@unito/integration-cli", "pluginType": "core", "strict": true, "summary": "Perform an OAuth2 workflow to either populate or refresh a test account's credentials.", "enableJsonFlag": false, "isESM": false, "relativePath": [ "dist", "src", "commands", "oauth2.js" ] }, "publish": { "aliases": [], "args": {}, "description": "Publish your integration", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "environment": { "description": "the environment of the platform", "name": "environment", "default": "production", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "staging", "production" ], "type": "option" }, "registry-only": { "description": "(advanced) only update the registry", "exclusive": [ "preview", "live-preview" ], "hidden": true, "name": "registry-only", "allowNo": false, "type": "boolean" }, "preview": { "description": "preview the integration - your integration will run and be privately accessible on the target environment", "exclusive": [ "registry-only", "live-preview" ], "name": "preview", "allowNo": false, "type": "boolean" }, "live-preview": { "description": "live-preview the integration - Useful to iterate quickly during development, your integration runs locally and is privately accessible on the target environment", "exclusive": [ "registry-only", "preview" ], "name": "live-preview", "allowNo": false, "type": "boolean" }, "config-path": { "description": "Use a custom configuration file instead of the default '.unito.json' or other environment specific\n ones.\n\n If you want to force the CLI to use a specific configuration file, you can use this flag to specify the relative\n path from your integration's root folder (with a leading '/').\n\n Usage: <%= config.bin %> <%= command.id %> --config-path=/myCustomConfig.json", "name": "config-path", "summary": "relative path to a custom \".unito.json\" file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "description": "bypass the confirmation prompt and force the command to run - this is useful for CI/CD pipelines", "hidden": true, "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "publish", "pluginAlias": "@unito/integration-cli", "pluginName": "@unito/integration-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": false, "relativePath": [ "dist", "src", "commands", "publish.js" ] }, "test": { "aliases": [], "args": {}, "description": "Test your integration", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "environment": { "description": "the environment of the platform", "name": "environment", "default": "production", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "staging", "production" ], "type": "option" }, "verbose": { "description": "output more (debug) information", "name": "verbose", "allowNo": false, "type": "boolean" }, "starting-path": { "description": "starting path of the crawler", "name": "starting-path", "default": "/", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "starting-operation": { "description": "starting operation of the crawler", "name": "starting-operation", "default": "getItem", "hasDynamicHelp": false, "multiple": false, "options": [ "getCollection", "getItem", "getBlob", "createItem", "updateItem", "deleteItem", "subscribeWebhook", "unsubscribeWebhook", "getCredentialAccount" ], "type": "option" }, "output-path": { "description": "output report in JSON format at the specified path", "name": "output-path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "credential-payload": { "description": "(advanced) credential payload to use.", "exclusive": [ "credential-id" ], "name": "credential-payload", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "credential-id": { "description": "(advanced) credential to use.", "exclusive": [ "credential-payload" ], "name": "credential-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "test-account": { "description": "test account to use.", "name": "test-account", "default": "development", "hasDynamicHelp": false, "multiple": false, "options": [ "development", "compliance" ], "type": "option" }, "read-only": { "description": "whether or not to only perform read operations", "name": "read-only", "allowNo": true, "type": "boolean" }, "timeout": { "description": "timeout in seconds passed as 'X-Unito-Operation-Deadline' header to the integration. Set to 0 for no timeout.", "name": "timeout", "default": 20, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "crawlMode": { "description": "mode to use while crawling the integration graph", "name": "crawlMode", "default": "full", "hasDynamicHelp": false, "multiple": false, "options": [ "full", "sample", "single" ], "type": "option" }, "checks": { "description": "checks to perform while crawling the integration graph", "name": "checks", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "debug": { "description": "log launch command to console before running it - including decrypted values - for debugging only", "hidden": true, "name": "debug", "allowNo": false, "type": "boolean" }, "config-path": { "description": "use a custom configuration file instead of the default '.unito.json' or other environment specific\n ones.\n\n If you want to force the CLI to use a specific configuration file, you can use this flag to specify the relative\n path from your integration's root folder (with a leading '/').\n\n Usage: <%= config.bin %> <%= command.id %> --config-path=/myCustomConfig.json", "name": "config-path", "summary": "relative path to a custom \".unito.json\" file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "skip-install": { "description": "whether or not to run npm install before starting the integration. Useful when npx linking modules to the integration.", "name": "skip-install", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "test", "pluginAlias": "@unito/integration-cli", "pluginName": "@unito/integration-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": false, "relativePath": [ "dist", "src", "commands", "test.js" ] }, "upgrade": { "aliases": [], "args": {}, "description": "Upgrade the CLI", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "upgrade", "pluginAlias": "@unito/integration-cli", "pluginName": "@unito/integration-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": false, "relativePath": [ "dist", "src", "commands", "upgrade.js" ] } }, "version": "0.64.4" }