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 flag	Description
`--print-command`	Prints the command that was executed.
`--verbose`	Prints 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 flag	Short flag	Description
`--targetDir`	`-d`	The directory to create the app in.
`--name`	`-n`	The 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 flag	Short flag	Description
`--appId`	`-a`	The app's unique identifier.
`--directoryPath`	`-d`	The project's directory path. If excluded, the working directory will be used.
`--force`	`-f`	Force push to the latest version (draft or live).
`--appVersionId`	`-v`	The version's unique identifier.
`--region`	`-z`	The 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-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 flag	Short flag	Description
`--appId`	`-a`	The app's unique identifier.
`--appFeatureId`	`-d`	The app feature's unique identifier.
`--appVersionId`	`-i`	The app version's unique identifier.
`--buildType`	`-t`	The build type: `custom_url` or `monday_code`.
`--customUrl`	`-u`	The 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 flag	Short flag	Description	Accepted values
`--appId`	`-a`	The app's unique identifier.
`--appVersionId`	`-i`	The app version's unique identifier.
`--featureName`	`-n`	The feature's name.
`--featureType`	`-t`	The 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 flag	Short flag	Description
`-appId`	`-a`	The app's unique identifier.
`--appVersionId`	`-i`	The 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 flag	Short flag	Description
`--appVersionId`	`-i`	The 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 flag	Short flag	Description
`--appId`	`-i`	The 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

Argument	Description
SHELL	The shell type: `zsh`, `bash`, or `powershell`.

Flags

Long flag	Short flag	Description
`--refresh-cache`	`-r`	Refreshes 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 flag	Short flag	Description
`--appId`	`-i`	The app's ID.
`--key`	`-k`	The variable key (required for `set` and `delete`).
`--mode`	`-m`	The management mode: `list-keys`, `set`, or`delete`.
`--value`	`-v`	The variable value (required for `set`).
`--region`	`-z`	The 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 flag	Short flag	Description
`--logsEndDate`	`-e`	The log's end date (e.g. MM/DD/YYYY HH:mm). Only supported for `history` events.
`--logsStartDate`	`-f`	The log's start date (e.g. MM/DD/YYYY HH:mm). Only supported for `history` events.
`--appVersionId`	`-i`	The app's version ID.
`--logSearchFromText`	`-r`	The regex text to search the logs for. Only supported for `live` events.
`--eventSource`	`-s`	The log's source: `live` (live events) or `history` (past events).
`--logsType`	`-t`	The log's type: `http` (http events) or `console` (stdout).
`--region`	`-z`	The 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-code. It is only available for monday-code projects.

Flags

Long flag	Short flag	Description
`--appId`	`-a`	The app's ID.
`--directoryPath`	`-d`	The project's directory path. If excluded, the working directory will be used.
`--force`	`-f`	Force push to the latest version (draft or live).
`--appVersionId`	`-i`	The app's version ID.
`--region`	`-z`	The region to use: `us`, `au`, `eu`.

Example

$ mapps code:push -d <PROJECT 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 projects.

Flags

Long flag	Short flag	Description
`-appId`	`-i`	The app's ID.
`--key`	`-k`	The variable key (required for `set` and `delete`).
`--mode`	`-m`	The management mode: `list-keys`, `set`, or `delete`.
`--value`	`-v`	The variable value (required for `set`).
`--region`	`-z`	The 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 projects.

Flags

Long flag	Short flag	Description
`--appVersionId`	`-i`	The app's version ID.
`--region`	`-z`	The 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

Argument	Description
`COMMANDS`	The command to show help for.

Flags

Long flag	Short flag	Description
`--nested-commands`	`-n`	Includes 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 flag	Short flag	Description
`--local`	`-l`	Creates 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`	`-t`	The API access token.

Example

$ mapps init -t <SECRET_TOKEN>

`mapps storage:export`

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

Long flag	Short flag	Description
`--appId`	`-a`	The app to retrieve the key for.
`--clientAccountId`	`-c`	The client account number.
`--fileDirectory`	`-d`	The file path. Optional. If not used, it will take your current folder.
`--fileFormat`	`-f`	The 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 flag	Short flag	Description
`--appId`	`-a`	The app's ID.
`--clientAccountId`	`-c`	The client account number.
`--force`	`-f`	Skip 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 flag	Short flag	Description
`--appId`	`-a`	The app to retrieve the key for.
`--clientAccountId`	`-c`	The client account number.
`--term`	`-t`	The 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 flag	Short flag	Description
`--appId`	`-a`	The unique identifier of the app to get a unique tunnel domain for.
`--port`	`-p`	The port to forward tunnel traffic to. The default is 8080.

Example

$ mapps tunnel:create -p 3000 -a 123456789