Guides
API DocsCommunityNeed Help?
Start typing to search…

Command line interface (CLI)

The monday CLI enables you to interact with the apps framework using a set of predefined commands to execute various operations. This document explains how to install the CLI and walks through the supported commands, but you can also access the CLI here.

Installation

To start using the CLI, you must first install it using the following command: 

$ npm install -g @mondaycom/apps-cli

After installing the CLI, use the mapps init command to add your API token: 

$ mapps init -t <SECRET_TOKEN>

Commands

Global flags

The following global flags are optional and can be used on any command.

Global flagDescription
--print-commandPrints the command that was executed.
--verbosePrints advanced logs.

mapps api:generate

The mapps api:generate command prepares your environment for custom query development by creating all necessary files and scripts. Make sure to run it from your root directory!

Example

$ mapps api:generate

mapps app:create

The mapps app:create command creates an app.

Flags

Long flagShort flagDescription
--targetDir-dThe directory to create the app in.
--name-nThe new app's name.

Example

$ mapps app:create -n NEW_APP_NAME

mapps app:deploy

The mapps app:deploy command deploys an app using manifest file.

Flags

Long flagShort flagDescription
--appId-aThe app's unique identifier.
--directoryPath-dThe project's directory path. If excluded, the working directory will be used.
--force-fForce push to the latest version (draft or live).
--appVersionId-vThe version's unique identifier.
--region-zThe region to use: us, au, or eu.

Example

$ mapps app:deploy

mapps app:list

The mapps app:list command lists all apps for a specific user.

Example

$ mapps app:list

mapps app:promote

The mapps app:promote command promotes an app's draft version to live.

Flags

Long flagShort flagDescription
--appId-aThe app's unique identifier.
--appVersionId-iThe app version's unique identifier

Example

$ mapps app:promote -i <APP_VERSION_ID> -a <APP_ID>

mapps app-features:build

The mapps app-features:build command creates a new app feature build. Please note that it currently only supports custom URL or monday code build types.

Flags

Long flagShort flagDescription
--appId-aThe app's unique identifier.
--appFeatureId-dThe app feature's unique identifier.
--appVersionId-iThe app version's unique identifier.
--buildType-tThe build type: custom_url or monday_code.
--customUrl-uThe custom URL for your app's build (if applicable).

Example

$ mapps app-features:build 
// or
$ mapps app-features:build -a 123456789 -i 987654321 -d 17654321 -t custom_url -u https://www.test.com
// or 
$ mapps app-features:build -a 123456789 -i 987654321 -d 17654321 -t monday_code -u /triggers

mapps app-features:create

The mapps app-features:create command creates a new app feature.

Flags

Long flagShort flagDescriptionAccepted values
--appId-aThe app's unique identifier.
--appVersionId-iThe app version's unique identifier.
--featureName-nThe feature's name.
--featureType-tThe feature's type.
  • AppFeatureBoardView
  • AppFeatureAiBoardMainMenuHeader
  • AppFeatureDashboardWidget
  • AppFeatureItemMenuAction
  • AppFeatureItemBatchAction
  • AppFeatureGroupMenuAction
  • AppFeatureObject
  • AppFeatureWorkspaceView
  • AppFeatureItemView
  • AppFeatureAiDocQuickStart
  • AppFeatureAiDocTopBar
  • AppFeatureAiDocSlashCommand
  • AppFeatureDocActions
  • AppFeatureIntegration
  • AppFeatureProductView

    • mapps app-features:list

    The mapps app-features:list command lists all features for a specific app version.

    Flags

    Long flagShort flagDescription
    -appId-aThe app's unique identifier.
    --appVersionId-iThe app version's unique identifier.

    Example

    $ mapps app-features:list 
// or 
$ mapps app-features:list -a 123456789 -i 987654321

    mapps app-version:builds

    The mapps app-version:builds command lists all builds for a specific app version.

    Flags

    Long flagShort flagDescription
    --appVersionId-iThe version's unique identifier.
    $ mapps app-version:builds -t 987654321

    mapps app-version:list

    The mapps app-version:list command lists all versions for a particular app.

    Flags

    Long flagShort flagDescription
    --appId-iThe app's unique identifier.

    Example

    $ mapps app-version:list -i 1234567890

    mapps autocomplete [SHELL]

    The mapps autocomplete [SHELL] command displays the autocomplete installation instructions.

    Arguments

    ArgumentDescription
    SHELLThe shell type: zsh, bash, or powershell.

    Flags

    Long flagShort flagDescription
    --refresh-cache-rRefreshes the cache (ignores displaying instructions).

    Example

    $ mapps autocomplete bash

    mapps code:env

    The mapps code:env command manages environment variables for your app hosted on monday code.

    Flags

    Long flagShort flagDescription
    --appId-iThe app's ID.
    --key-kThe variable key (required for set and delete).
    --mode-mThe management mode: list-keys, set, ordelete.
    --value-vThe variable value (required for set).
    --region-zThe region to use: us, au, or eu.

    Example

    $ mapps code:env -m set -k <KEY> -v <VALUE>

    mapps code:logs

    The mapps code:logs command streams logs.

    Flags

    Long flagShort flagDescription
    --logsEndDate-eThe log's end date (e.g. MM/DD/YYYY HH:mm). Only supported for history events.
    --logsStartDate-fThe log's start date (e.g. MM/DD/YYYY HH:mm). Only supported for history events.
    --appVersionId-iThe app's version ID.
    --logSearchFromText-rThe regex text to search the logs for. Only supported for live events.
    --eventSource-sThe log's source: live (live events) or history (past events).
    --logsType-tThe log's type: http (http events) or console (stdout).
    --region-zThe region to use: us, au, or eu.

    Example

    $ mapps code:logs -i <APP_VERSION_ID> -t <LOGS_TYPE>

    mapps code:push

    The mapps code:push command pushes your project to be hosted on monday.com's infrastructure.

    Flags

    Long flagShort flagDescriptionNotes
    --appId-aThe app's ID.
    --client-side-cPushes client-side code to monday.com (4.6.0 and above).Uploads code to our CDN for faster load times and reduced latency (recommended). The directory must include a root-level index.html.
    --directoryPath-dThe project's directory path. If excluded, the working directory will be used.When using a bundler, make sure the directory path is the build directory (e.g.,"./dist").
    --force-fForce push to the latest version (draft or live).
    --appVersionId-iThe app's version ID.
    --region-zThe region to use: us, au, eu.

    Example

    $ mapps code:push -d <PROJECT BUILD DIRECTORY PATH> -i <APP_VERSION_ID_TO_PUSH>

    mapps code:secret

    The mapps code:secret command manages secret variables for your app hosted on monday-code. It is only available for monday code apps.

    Flags

    Long flagShort flagDescription
    -appId-iThe app's ID.
    --key-kThe variable key (required for set and delete).
    --mode-mThe management mode: list-keys, set, or delete.
    --value-vThe variable value (required for set).
    --region-zThe region to use: us, au, eu.

    Example

    $ mapps code:secret -m set -k <KEY> -v <VALUE>

    mapps code:status

    The mapps code:status command provides the status of a specific project hosted on monday-code. It is only available for monday code apps.

    Flags

    Long flagShort flagDescription
    --appVersionId-iThe app's version ID.
    --region-zThe region to use: us, au, eu.

    Example

    $ mapps code:status -i <APP_VERSION_ID>

    mapps help [COMMANDS]

    The mapps help [COMMANDS] command displays help for mapps.

    Arguments

    ArgumentDescription
    COMMANDSThe command to show help for.

    Flags

    Long flagShort flagDescription
    --nested-commands-nIncludes all nested commands in the output.

    Example

    $ mapps help [COMMANDS] [-n]

    mapps init

    The mapps init command initializes the mapps config file (i.e., ".mappsrc"). You can use this command to add your API token to access the CLI.

    Flags

    Long flagShort flagDescription
    --local-lCreates the configuration file locally in the current project working directory. Use this if you are using different access tokens for each of your projects.
    --token-tThe API access token.

    Example

    $ mapps init -t <SECRET_TOKEN>

    mapps scheduler:create

    The mapps scheduler:create command creates a new scheduled cron job. It is only available for monday code apps.

    Flags

    Long flagShort flagDescriptionNotes
    --appId-aThe app's unique identifier.
    --minBackoffDuration-bThe minimum backoff duration between retries.The value should be in seconds. Optional. If omitted, the default will be 10 minutes.
    --description-dThe scheduled job's description.
    --name-nThe scheduled job's name. This is the unique identifier of the job for this app.There is no whitespace allowed. This should be unique to the job, but the names of deleted jobs can be reused.
    --maxRetries-rThe maximum number of retries for failed jobs.Optional.
    --schedule-sThe scheduled job's cron expression.Relative to UTC. Use a cron expression generator to ensure proper format (e.g., Cronhub ).
    --timeout-tThe job execution timeout.The value should be in seconds. Optional.
    --targetUrl-uThe job's target URL path.This must start with "/". It will be relative to /mndy-cronjob.
    --region-zThe region to use: us, au, or eu.

    Example

    $ mapps scheduler:create -a APP_ID -s "0 * * * *" -u "/my-endpoint" -n "My-scheduled-job" -d "This job will execute hourly." -r 3

    mapps scheduler:delete

    The mapps scheduler:delete command deletes a scheduled cron job. It is only available for monday code apps.

    Flags

    Long flagShort flagDescription
    --appId-aThe app's unique identifier.
    --name-nScheduled job name
    --region-zThe region to use: us, au, or eu.

    Example

    $ mapps scheduler:delete -a APP_ID -n "my-job"

    mapps scheduler:list

    The mapps scheduler:list command lists all scheduled cron jobs. It is only available for monday code apps.

    Flags

    Long flagShort flagDescription
    --appId-aThe app's unique identifier.

    Example

    $ mapps scheduler:list -a APP_ID

    mapps scheduler:run

    The mapps scheduler:run command runs a scheduled cron job. This can be used to invoke a scheduled job on demand instead of waiting for the next iteration of the schedule. It is only available for monday code apps.

    Flags

    Long flagShort flagDescription
    --appId-aThe app's unique identifier.
    --name-nScheduled job name
    --region-zThe region to use: us, au, or eu.

    Example

    $ mapps scheduler:run -a APP_ID -n "my-job"

    mapps scheduler:update

    The mapps scheduler:update command updates a scheduled cron job. It is only available for monday code apps.

    Flags

    Long flagShort flagDescriptionNotes
    --appId-aThe app's unique identifier.
    --minBackoffDuration-bThe minimum backoff duration between retries.The value should be in seconds. Optional. If omitted, the default will be 10 minutes.
    --description-dThe scheduled job's description.
    --name-nThe scheduled job's name. This is the unique identifier of the job for this app.There is no whitespace allowed. This should be unique to the job, but the names of deleted jobs can be reused.
    --maxRetries-rThe maximum number of retries for failed jobs.Optional.
    --schedule-sThe scheduled job's cron expression.Relative to UTC. Use a cron expression generator to ensure proper format (e.g., Cronhub).
    --timeout-tThe job execution timeout.The value should be in seconds. Optional.
    --targetUrl-uThe job's target URL path.This must start with "/". It will be relative to /mndy-cronjob.
    --region-zThe region to use: us, au, or eu.

    Example

    $ mapps scheduler:update -a APP_ID -n "my-job" -d "This job will execute automatically." -r 3 -b 10 -t 60

    mapps storage:export

    The mapps storage:export command exports all keys and values stored on monday for a specific customer account.

    Short flagLong flagDescription
    -a--appIdThe app to retrieve the key for.
    -c--clientAccountIdThe client account number.
    -d--fileDirectoryThe file path. Optional. If not used, it will take your current folder.
    -f--fileFormatThe file format: CSV or JSON. Optional, the default is JSON.

    Example

    $ mapps storage:export 
// or
$ mapps storage:export -a 12345678790 -c 9876543210

    mapps storage:remove-data

    The mapps storage:remove-data command removes all storage data for a specific customer account.

    Long flagShort flagDescription
    --appId-aThe app's ID.
    --clientAccountId-cThe client account number.
    --force-fSkip the confirmation step

    Example

    $ mapps storage:remove-data -a 1234567890 -c 9876543210

    mapps storage:search

    The mapps storage:search command searches keys and values stored on monday for a specific customer account.

    Long flagShort flagDescription
    --appId-aThe app to retrieve the key for.
    --clientAccountId-cThe client account number.
    --term-tThe term to search for.

    Example

    $ mapps storage:search 
// or 
$ mapps storage:search -a 1234567890 -c 9876543210 -t keyword

    mapps tunnel:create

    The mapps tunnel:create command creates a networking tunnel to publicly expose code running on the local machine.

    Flags

    Long flagShort flagDescription
    --appId-aThe unique identifier of the app to get a unique tunnel domain for.
    --port-pThe port to forward tunnel traffic to. The default is 8080.

    Example

    $ mapps tunnel:create -p 3000 -a 123456789

    Updated 8 days ago