@mondaycom/apps-cli

{ "commands": { "api:generate": { "aliases": [], "args": {}, "description": "Prepares your environment for custom queries development. run it from your root directory!\n Creates all necessary files and scripts\n to start working with custom api queries and mutations.\n Read the documentation at [@mondaydotcomorg/setup-api](https://github.com/mondaycom/monday-graphql-api/tree/main/packages/setup-api)", "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "api:generate", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "_withPrintCommand": true, "sharedFlags": { "verbose": { "description": "Print advanced logs (optional).", "default": false, "helpGroup": "global", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "default": false, "helpGroup": "global", "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "api", "generate.js" ], "aliasPermutations": [], "permutations": [ "api:generate", "generate:api" ] }, "app:create": { "aliases": [], "args": {}, "description": "Create an app.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> -n NEW_APP_NAME" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "name": { "char": "n", "description": "Name your new app.", "name": "name", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "targetDir": { "char": "d", "description": "Directory to create the app in.", "name": "targetDir", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:create", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "app", "create.js" ], "aliasPermutations": [], "permutations": [ "app:create", "create:app" ] }, "app:deploy": { "aliases": [], "args": {}, "description": "Deploy an app using manifest file.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "directoryPath": { "char": "d", "description": "Directory path of you project in your machine. If not included will use the current working directory.", "name": "directoryPath", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "appId": { "aliases": [ "appId" ], "char": "a", "description": "App id (will use the latest draft version)", "name": "appId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "appVersionId": { "aliases": [ "versionId" ], "char": "v", "description": "App version id", "name": "appVersionId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "aliases": [ "force" ], "char": "f", "description": "Force push to latest version (draft or live)", "name": "force", "allowNo": false, "type": "boolean" }, "region": { "char": "z", "description": "Region to use", "name": "region", "hasDynamicHelp": false, "multiple": false, "options": [ "us", "eu", "au", "il" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:deploy", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "withPrintCommand": false, "isESM": true, "relativePath": [ "dist", "commands", "app", "deploy.js" ], "aliasPermutations": [], "permutations": [ "app:deploy", "deploy:app" ] }, "app:list": { "aliases": [], "args": {}, "description": "List all apps for a specific user.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:list", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "withPrintCommand": false, "isESM": true, "relativePath": [ "dist", "commands", "app", "list.js" ], "aliasPermutations": [], "permutations": [ "app:list", "list:app" ] }, "app:promote": { "aliases": [], "args": {}, "description": "Promote an app to live.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %>" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "appId": { "char": "a", "description": "App id to promote", "name": "appId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "appVersionId": { "aliases": [ "v" ], "char": "i", "description": "App version id to promote", "name": "appVersionId", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:promote", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "app", "promote.js" ], "aliasPermutations": [], "permutations": [ "app:promote", "promote:app" ] }, "app:scaffold": { "aliases": [], "args": { "destination": { "description": "The destination directory for the scaffolded project", "name": "destination", "required": false }, "project": { "description": "The name of the template project to scaffold", "name": "project", "required": false } }, "description": "Scaffold a monday app from a template, install dependencies, and start the project automatically.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> ./my-app quickstart-react", "<%= config.bin %> <%= command.id %> ./my-app slack-node --signingSecret YOUR_SECRET", "<%= config.bin %> <%= command.id %> ./my-app word-cloud --command dev" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "signingSecret": { "char": "s", "description": "monday signing secret (for .env configuration)", "name": "signingSecret", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "command": { "char": "c", "description": "npm script command to run after installation (default: start)", "name": "command", "required": false, "default": "start", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:scaffold", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "_withPrintCommand": true, "sharedFlags": { "verbose": { "description": "Print advanced logs (optional).", "default": false, "helpGroup": "global", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "default": false, "helpGroup": "global", "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "app", "scaffold.js" ], "aliasPermutations": [], "permutations": [ "app:scaffold", "scaffold:app" ] }, "app-features:build": { "aliases": [], "args": {}, "description": "Perform operations related to app features in monday.com", "examples": [ "<%= config.bin %> <%= command.id %> -a APP_ID -i APP_VERSION_ID -d APP_FEATURE_ID -t BUILD_TYPE -u CUSTOM_URL" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "appId": { "aliases": [ "appId" ], "char": "a", "description": "Please enter app id:", "name": "appId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "appVersionId": { "aliases": [ "versionId" ], "char": "i", "description": "Please enter the app version id of your app:", "name": "appVersionId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "appFeatureId": { "aliases": [ "featureId" ], "char": "d", "description": "Please enter the app feature id of your app:", "name": "appFeatureId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "buildType": { "aliases": [ "type" ], "char": "t", "description": "Build type", "name": "buildType", "hasDynamicHelp": false, "multiple": false, "options": [ "custom_url", "monday_code", "monday_code_cdn" ], "type": "option" }, "customUrl": { "aliases": [ "customUrl" ], "char": "u", "description": "Custom url", "name": "customUrl", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app-features:build", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "app-features", "build.js" ], "aliasPermutations": [], "permutations": [ "app-features:build", "build:app-features" ] }, "app-features:create": { "aliases": [], "args": {}, "description": "Create an app feature.", "examples": [ "<%= config.bin %> <%= command.id %> -a APP_ID -i APP_VERSION_ID -t APP-FEATURE-TYPE" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "appId": { "aliases": [ "appId" ], "char": "a", "description": "Please enter app id:", "name": "appId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "appVersionId": { "aliases": [ "versionId" ], "char": "i", "description": "Please enter the app version id of your app:", "name": "appVersionId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "featureType": { "char": "t", "description": "Feature type", "name": "featureType", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "featureName": { "char": "n", "description": "Feature name", "name": "featureName", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app-features:create", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "app-features", "create.js" ], "aliasPermutations": [], "permutations": [ "app-features:create", "create:app-features" ] }, "app-features:list": { "aliases": [], "args": {}, "description": "List all features for a specific app version.", "examples": [ "<%= config.bin %> <%= command.id %> -a APP_ID -i APP_VERSION_ID" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "appId": { "aliases": [ "appId" ], "char": "a", "description": "Please enter app id:", "name": "appId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "appVersionId": { "aliases": [ "versionId" ], "char": "i", "description": "Please enter the app version id of your app:", "name": "appVersionId", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app-features:list", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "app-features", "list.js" ], "aliasPermutations": [], "permutations": [ "app-features:list", "list:app-features" ] }, "app-version:builds": { "aliases": [], "args": {}, "description": "List all builds for a specific app version", "examples": [ "<%= config.bin %> <%= command.id %> -i APP_VERSION_ID" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "appVersionId": { "aliases": [ "v" ], "char": "i", "description": "Please enter the app version id of your app:", "name": "appVersionId", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app-version:builds", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "app-version", "builds.js" ], "aliasPermutations": [], "permutations": [ "app-version:builds", "builds:app-version" ] }, "app-version:list": { "aliases": [], "args": {}, "description": "List all versions for a specific app.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "appId": { "aliases": [ "a" ], "char": "i", "description": "Please enter app id:", "name": "appId", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app-version:list", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "app-version", "list.js" ], "aliasPermutations": [], "permutations": [ "app-version:list", "list:app-version" ] }, "code:env": { "aliases": [], "args": {}, "description": "Manage environment variables for your app hosted on monday-code.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "appId": { "aliases": [ "a" ], "char": "i", "description": "The id of the app to manage environment variables for", "name": "appId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "mode": { "char": "m", "description": "management mode", "name": "mode", "hasDynamicHelp": false, "multiple": false, "options": [ "list-keys", "set", "delete" ], "type": "option" }, "key": { "char": "k", "description": "variable key [required for set and delete]]", "name": "key", "relationships": [ { "type": "all", "flags": [ { "name": "mode" } ] } ], "hasDynamicHelp": false, "multiple": false, "type": "option" }, "value": { "char": "v", "description": "variable value [required for set]", "name": "value", "relationships": [ { "type": "all", "flags": [ { "name": "mode" } ] } ], "hasDynamicHelp": false, "multiple": false, "type": "option" }, "region": { "char": "z", "description": "Region to use", "name": "region", "hasDynamicHelp": false, "multiple": false, "options": [ "us", "eu", "au", "il" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "code:env", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "code", "env.js" ], "aliasPermutations": [], "permutations": [ "code:env", "env:code" ] }, "code:logs": { "aliases": [], "args": {}, "description": "Stream logs", "examples": [ "<%= config.bin %> <%= command.id %> -i APP_VERSION_ID -t LOGS_TYPE" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "appVersionId": { "aliases": [ "v" ], "char": "i", "description": "Please enter the app version id of your app:", "name": "appVersionId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "logsType": { "char": "t", "description": "Logs type: \"http\" for http events, \"console\" for stdout", "name": "logsType", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "eventSource": { "char": "s", "description": "Source: \"live\" for live events, \"History\" for fetching events from the past", "name": "eventSource", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "logsStartDate": { "char": "f", "description": "Start date (MM/DD/YYYY HH:mm) e.g. \"03/24/1983 15:45\" [supported only if eventSource=live]", "name": "logsStartDate", "relationships": [ { "type": "none", "flags": [ { "name": "eventSource" } ] } ], "hasDynamicHelp": false, "multiple": false, "type": "option" }, "logsEndDate": { "char": "e", "description": "End date (MM/DD/YYYY HH:mm) e.g. \"03/25/1983 16:45\" [supported only if eventSource=live]", "name": "logsEndDate", "relationships": [ { "type": "none", "flags": [ { "name": "eventSource" } ] } ], "hasDynamicHelp": false, "multiple": false, "type": "option" }, "logSearchFromText": { "char": "r", "description": "text: a text in regex that will be searched among the logs text [supported only if eventSource=live]", "name": "logSearchFromText", "relationships": [ { "type": "none", "flags": [ { "name": "eventSource" } ] } ], "hasDynamicHelp": false, "multiple": false, "type": "option" }, "region": { "char": "z", "description": "Region to use", "name": "region", "hasDynamicHelp": false, "multiple": false, "options": [ "us", "eu", "au", "il" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "code:logs", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "code", "logs.js" ], "aliasPermutations": [], "permutations": [ "code:logs", "logs:code" ] }, "code:push": { "aliases": [], "args": {}, "description": "Push your project to get hosted on monday-code.", "examples": [ "<%= config.bin %> <%= command.id %> -d PROJECT DIRECTORY PATH -i APP_VERSION_ID_TO_PUSH", "<%= config.bin %> <%= command.id %> -i APP_VERSION_ID_TO_PUSH", "<%= config.bin %> <%= command.id %> -a APP_ID_TO_PUSH" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "directoryPath": { "char": "d", "description": "Directory path of you project in your machine. If not included will use the current working directory.", "name": "directoryPath", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "appId": { "char": "a", "description": "Please enter app id:", "name": "appId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "appVersionId": { "aliases": [ "v" ], "char": "i", "description": "Please enter the app version id of your app:", "name": "appVersionId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Force push to live version", "name": "force", "allowNo": false, "type": "boolean" }, "client-side": { "char": "c", "description": "Push files to CDN", "name": "client-side", "allowNo": false, "type": "boolean" }, "security-scan": { "char": "s", "description": "Run a security scan to find dependency vulnerabilities during code deployment", "name": "security-scan", "allowNo": false, "type": "boolean" }, "region": { "char": "z", "description": "Region to use", "name": "region", "hasDynamicHelp": false, "multiple": false, "options": [ "us", "eu", "au", "il" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "code:push", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "code", "push.js" ], "aliasPermutations": [], "permutations": [ "code:push", "push:code" ] }, "code:report": { "aliases": [], "args": {}, "description": "Get security scan report for a monday-code deployment.", "examples": [ "<%= config.bin %> <%= command.id %> -i APP_VERSION_ID", "<%= config.bin %> <%= command.id %> -i APP_VERSION_ID -o", "<%= config.bin %> <%= command.id %> -i APP_VERSION_ID -o -d /path/to/directory" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "appVersionId": { "aliases": [ "v" ], "char": "i", "description": "Please enter the app version id of your app:", "name": "appVersionId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output": { "char": "o", "description": "Save the full report to a JSON file", "name": "output", "allowNo": false, "type": "boolean" }, "outputDir": { "char": "d", "dependsOn": [ "output" ], "description": "Directory to save the report file (requires -o flag)", "name": "outputDir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "region": { "char": "z", "description": "Region to use", "name": "region", "hasDynamicHelp": false, "multiple": false, "options": [ "us", "eu", "au", "il" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "code:report", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "code", "report.js" ], "aliasPermutations": [], "permutations": [ "code:report", "report:code" ] }, "code:secret": { "aliases": [], "args": {}, "description": "Manage secret variables for your app hosted on monday-code.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "appId": { "aliases": [ "a" ], "char": "i", "description": "The id of the app to manage secret variables for", "name": "appId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "mode": { "char": "m", "description": "management mode", "name": "mode", "hasDynamicHelp": false, "multiple": false, "options": [ "list-keys", "set", "delete" ], "type": "option" }, "key": { "char": "k", "description": "variable key [required for set and delete]]", "name": "key", "relationships": [ { "type": "all", "flags": [ { "name": "mode" } ] } ], "hasDynamicHelp": false, "multiple": false, "type": "option" }, "value": { "char": "v", "description": "variable value [required for set]", "name": "value", "relationships": [ { "type": "all", "flags": [ { "name": "mode" } ] } ], "hasDynamicHelp": false, "multiple": false, "type": "option" }, "region": { "char": "z", "description": "Region to use", "name": "region", "hasDynamicHelp": false, "multiple": false, "options": [ "us", "eu", "au", "il" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "code:secret", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "code", "secret.js" ], "aliasPermutations": [], "permutations": [ "code:secret", "secret:code" ] }, "code:status": { "aliases": [], "args": {}, "description": "Status of a specific project hosted on monday-code.", "examples": [ "<%= config.bin %> <%= command.id %> -i APP_VERSION_ID" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "appVersionId": { "aliases": [ "v" ], "char": "i", "description": "Please enter the app version id of your app:", "name": "appVersionId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "region": { "char": "z", "description": "Region to use", "name": "region", "hasDynamicHelp": false, "multiple": false, "options": [ "us", "eu", "au", "il" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "code:status", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "code", "status.js" ], "aliasPermutations": [], "permutations": [ "code:status", "status:code" ] }, "database:connection-string": { "aliases": [], "args": {}, "description": "Get the connection string for your app database.", "examples": [ "<%= config.bin %> <%= command.id %> -a APP_ID" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "appId": { "char": "a", "description": "Select the app that you wish to retrieve the connection string for", "name": "appId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "region": { "char": "z", "description": "Region to use", "name": "region", "hasDynamicHelp": false, "multiple": false, "options": [ "us", "eu", "au", "il" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "database:connection-string", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "database", "connection-string.js" ], "aliasPermutations": [], "permutations": [ "database:connection-string", "connection-string:database" ] }, "init": { "aliases": [], "args": {}, "description": "Initialize mapps config file - \".mappsrc\".", "examples": [ "<%= config.bin %> <%= command.id %> -t SECRET_TOKEN" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "token": { "char": "t", "description": "monday.com api access token (https://developer.monday.com/api-reference/docs/authentication)", "name": "token", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "local": { "char": "l", "description": "create the configuration file locally, in the current project working directory", "name": "local", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "init", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "_withPrintCommand": true, "sharedFlags": { "verbose": { "description": "Print advanced logs (optional).", "default": false, "helpGroup": "global", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "default": false, "helpGroup": "global", "allowNo": false, "type": "boolean" } }, "withPrintCommand": false, "isESM": true, "relativePath": [ "dist", "commands", "init", "index.js" ], "aliasPermutations": [], "permutations": [ "init" ] }, "manifest:export": { "aliases": [], "args": {}, "description": "export app manifest.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> -p ./exports", "<%= config.bin %> <%= command.id %> --manifestPath ./my-manifests" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "manifestPath": { "char": "p", "description": "Path to export your app manifest files to", "name": "manifestPath", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "appId": { "char": "a", "description": "App id (will export the live version)", "name": "appId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "appVersionId": { "aliases": [ "v" ], "char": "i", "description": "App version id", "name": "appVersionId", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "manifest:export", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "withPrintCommand": false, "isESM": true, "relativePath": [ "dist", "commands", "manifest", "export.js" ], "aliasPermutations": [], "permutations": [ "manifest:export", "export:manifest" ] }, "manifest:import": { "aliases": [], "args": {}, "description": "Import manifest with optional template variables.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> -p ./manifest.json", "<%= config.bin %> <%= command.id %> --manifestPath ./manifest.json" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "manifestPath": { "char": "p", "description": "Path to your app manifest file on your machine", "name": "manifestPath", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "appId": { "char": "a", "description": "App id (will create a new draft version)", "name": "appId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "appVersionId": { "aliases": [ "v" ], "char": "i", "description": "App version id to override", "name": "appVersionId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "newApp": { "aliases": [ "new" ], "char": "n", "description": "Create new app", "name": "newApp", "allowNo": false, "type": "boolean" }, "allowMissingVariables": { "aliases": [ "allow-missing-variables" ], "char": "m", "description": "Allow missing variables", "name": "allowMissingVariables", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "manifest:import", "pluginAlias": "@mondaycom/apps-cli", "pluginName": "@mondaycom/apps-cli", "pluginType": "core", "strict": true, "withPrintCommand": false, "isESM": true, "relativePath": [ "dist", "commands", "manifest", "import.js" ], "aliasPermutations": [], "permutations": [ "manifest:import", "import:manifest" ] }, "scheduler:create": { "aliases": [], "args": {}, "description": "Create a new scheduler job for an app", "examples": [ "<%= config.bin %> <%= command.id %> -a APP_ID -s \"0 * * * *\" -e \"my-endpoint\"", "<%= config.bin %> <%= command.id %> -a APP_ID -s \"0 * * * *\" -e \"my-endpoint\" -n \"My-special-job\" -d \"My description\"", "<%= config.bin %> <%= command.id %> -a APP_ID -s \"0 * * * *\" -e \"my-endpoint\" -r 3 -b 10 -t 60" ], "flags": { "verbose": { "description": "Print advanced logs (optional).", "helpGroup": "global", "name": "verbose", "allowNo": false, "type": "boolean" }, "print-command": { "aliases": [ "pc" ], "description": "Print the command that was executed (optional).", "helpGroup": "global", "name": "print-command", "allowNo": false, "type": "boolean" }, "appId": { "char": "a", "description": "Please enter app id:", "name": "appId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n",