@unito/integration-cli

{ "version": "0.63.4", "commands": { "activity": { "id": "activity", "description": "Show the activity associated with your integration", "strict": true, "pluginName": "@unito/integration-cli", "pluginAlias": "@unito/integration-cli", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "number": { "name": "number", "type": "option", "char": "n", "summary": "number of events to show", "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", "multiple": false }, "environment": { "name": "environment", "type": "option", "description": "the environment of the platform", "multiple": false, "options": [ "local", "staging", "production" ], "default": "production" }, "follow": { "name": "follow", "type": "boolean", "char": "f", "summary": "follow the activity", "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", "allowNo": false } }, "args": {} }, "dev": { "id": "dev", "description": "Develop your integration", "strict": true, "pluginName": "@unito/integration-cli", "pluginAlias": "@unito/integration-cli", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "environment": { "name": "environment", "type": "option", "description": "the environment of the platform", "multiple": false, "options": [ "local", "staging", "production" ], "default": "production" }, "verbose": { "name": "verbose", "type": "boolean", "description": "output more (debug) information", "allowNo": false }, "credential-payload": { "name": "credential-payload", "type": "option", "description": "(advanced) credential payload to use.", "multiple": false, "exclusive": [ "credential-id" ] }, "credential-id": { "name": "credential-id", "type": "option", "description": "(advanced) credential to use.", "multiple": false, "exclusive": [ "credential-payload" ] }, "test-account": { "name": "test-account", "type": "option", "description": "test account to use.", "multiple": false, "options": [ "development", "compliance" ], "default": "development" }, "read-only": { "name": "read-only", "type": "boolean", "description": "whether or not to only perform read operations", "allowNo": true }, "timeout": { "name": "timeout", "type": "option", "description": "timeout in seconds passed as 'X-Unito-Operation-Deadline' header to the integration. Set to 0 for no timeout.", "multiple": false, "default": 0 }, "crawlMode": { "name": "crawlMode", "type": "option", "description": "mode to use while crawling the integration graph", "multiple": false, "options": [ "full", "sample", "single" ], "default": "full" }, "checks": { "name": "checks", "type": "option", "description": "checks to perform while crawling the integration graph", "multiple": true, "default": [] }, "config-path": { "name": "config-path", "type": "option", "summary": "relative path to a custom \".unito.json\" file", "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", "multiple": false }, "skip-install": { "name": "skip-install", "type": "boolean", "description": "whether or not to run npm install before starting the integration", "allowNo": true } }, "args": {} }, "encrypt": { "id": "encrypt", "description": "Encrypt data", "strict": true, "pluginName": "@unito/integration-cli", "pluginAlias": "@unito/integration-cli", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "environment": { "name": "environment", "type": "option", "description": "the environment of the platform", "multiple": false, "options": [ "local", "staging", "production" ], "default": "production" }, "sensitive": { "name": "sensitive", "type": "boolean", "description": "once encrypted, sensitive data cannot be decrypted", "allowNo": false } }, "args": {} }, "init": { "id": "init", "description": "Initialize a new integration", "strict": true, "pluginName": "@unito/integration-cli", "pluginAlias": "@unito/integration-cli", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --name pokemon" ], "flags": { "name": { "name": "name", "type": "option", "char": "n", "description": "Name of the integration", "multiple": false } }, "args": {} }, "invite": { "id": "invite", "description": "Invite a user to become a developer of your integration", "strict": true, "pluginName": "@unito/integration-cli", "pluginAlias": "@unito/integration-cli", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "environment": { "name": "environment", "type": "option", "description": "the environment of the platform", "multiple": false, "options": [ "local", "staging", "production" ], "default": "production" } }, "args": {} }, "login": { "id": "login", "description": "Login to the Integrations Platform", "strict": true, "pluginName": "@unito/integration-cli", "pluginAlias": "@unito/integration-cli", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "environment": { "name": "environment", "type": "option", "description": "the environment of the platform", "multiple": false, "options": [ "local", "staging", "production" ], "default": "production" } }, "args": {} }, "oauth2": { "id": "oauth2", "summary": "Perform an OAuth2 workflow to either populate or refresh a test account's credentials.", "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.", "strict": true, "pluginName": "@unito/integration-cli", "pluginAlias": "@unito/integration-cli", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --reauth --test-account=compliance" ], "flags": { "test-account": { "name": "test-account", "type": "option", "description": "Test account to use.", "multiple": false, "options": [ "development", "compliance" ], "default": "development" }, "environment": { "name": "environment", "type": "option", "description": "the environment of the platform", "hidden": true, "multiple": false, "options": [ "local", "staging", "production" ], "default": "production" }, "reauth": { "name": "reauth", "type": "boolean", "description": "triggers a new oauth2 flow to overwrite the test account's current credentials", "allowNo": false }, "config-path": { "name": "config-path", "type": "option", "summary": "relative path to a custom \".unito.json\" file", "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", "multiple": false } }, "args": {} }, "publish": { "id": "publish", "description": "Publish your integration", "strict": true, "pluginName": "@unito/integration-cli", "pluginAlias": "@unito/integration-cli", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "environment": { "name": "environment", "type": "option", "description": "the environment of the platform", "multiple": false, "options": [ "local", "staging", "production" ], "default": "production" }, "registry-only": { "name": "registry-only", "type": "boolean", "description": "(advanced) only update the registry", "hidden": true, "allowNo": false, "exclusive": [ "preview", "live-preview" ] }, "preview": { "name": "preview", "type": "boolean", "description": "preview the integration - your integration will run and be privately accessible on the target environment", "allowNo": false, "exclusive": [ "registry-only", "live-preview" ] }, "live-preview": { "name": "live-preview", "type": "boolean", "description": "live-preview the integration - Useful to iterate quickly during development, your integration runs locally and is privately accessible on the target environment", "allowNo": false, "exclusive": [ "registry-only", "preview" ] }, "config-path": { "name": "config-path", "type": "option", "summary": "relative path to a custom \".unito.json\" file", "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", "multiple": false }, "force": { "name": "force", "type": "boolean", "description": "bypass the confirmation prompt and force the command to run - this is useful for CI/CD pipelines", "hidden": true, "allowNo": false } }, "args": {} }, "test": { "id": "test", "description": "Test your integration", "strict": true, "pluginName": "@unito/integration-cli", "pluginAlias": "@unito/integration-cli", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "environment": { "name": "environment", "type": "option", "description": "the environment of the platform", "multiple": false, "options": [ "local", "staging", "production" ], "default": "production" }, "verbose": { "name": "verbose", "type": "boolean", "description": "output more (debug) information", "allowNo": false }, "starting-path": { "name": "starting-path", "type": "option", "description": "starting path of the crawler", "multiple": false, "default": "/" }, "starting-operation": { "name": "starting-operation", "type": "option", "description": "starting operation of the crawler", "multiple": false, "options": [ "getCollection", "getItem", "getBlob", "createItem", "updateItem", "deleteItem", "subscribeWebhook", "unsubscribeWebhook", "getCredentialAccount" ], "default": "getItem" }, "output-path": { "name": "output-path", "type": "option", "description": "output report in JSON format at the specified path", "multiple": false }, "credential-payload": { "name": "credential-payload", "type": "option", "description": "(advanced) credential payload to use.", "multiple": false, "exclusive": [ "credential-id" ] }, "credential-id": { "name": "credential-id", "type": "option", "description": "(advanced) credential to use.", "multiple": false, "exclusive": [ "credential-payload" ] }, "test-account": { "name": "test-account", "type": "option", "description": "test account to use.", "multiple": false, "options": [ "development", "compliance" ], "default": "development" }, "read-only": { "name": "read-only", "type": "boolean", "description": "whether or not to only perform read operations", "allowNo": true }, "timeout": { "name": "timeout", "type": "option", "description": "timeout in seconds passed as 'X-Unito-Operation-Deadline' header to the integration. Set to 0 for no timeout.", "multiple": false, "default": 20 }, "crawlMode": { "name": "crawlMode", "type": "option", "description": "mode to use while crawling the integration graph", "multiple": false, "options": [ "full", "sample", "single" ], "default": "full" }, "checks": { "name": "checks", "type": "option", "description": "checks to perform while crawling the integration graph", "multiple": true, "default": [] }, "debug": { "name": "debug", "type": "boolean", "description": "log launch command to console before running it - including decrypted values - for debugging only", "hidden": true, "allowNo": false }, "config-path": { "name": "config-path", "type": "option", "summary": "relative path to a custom \".unito.json\" file", "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", "multiple": false }, "skip-install": { "name": "skip-install", "type": "boolean", "description": "whether or not to run npm install before starting the integration. Useful when npx linking modules to the integration.", "allowNo": true } }, "args": {} }, "upgrade": { "id": "upgrade", "description": "Upgrade the CLI", "strict": true, "pluginName": "@unito/integration-cli", "pluginAlias": "@unito/integration-cli", "pluginType": "core", "aliases": [], "hiddenAliases": [], "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": {}, "args": {} } } }