The monday-code CLI enables you to interact with monday-code using a set of predefined commands. It currently contains the following commands that you can implement to execute various operations:

  • [`mapps init`](🔗)

  • [`mapps tunnel:create`](🔗)

  • [`mapps app-features:build`](🔗)

  • [`mapps app-features:list`](🔗)

  • [`mapps app-version:builds`](🔗)

  • [`mapps app-version:list`](🔗)

  • [`mapps app:list`](🔗)

  • [`mapps autocomplete [SHELL] [-r]`](🔗)

  • [`mapps code:env`](🔗)

  • [`mapps code:logs`](🔗)

  • [`mapps code:push`](🔗)

  • [`mapps code:status`](🔗)

  • [`mapps help [COMMANDS]`](🔗)

  • [`mapps storage:search`](🔗)

  • [`mapps storage:export`](🔗)

This document will walk through each available command, its flags, and relevant code samples. You can also access the CLI <a href="https://www.npmjs.com/package/@mondaycom/apps-cli" target="_blank">here</a>.

**Please note** that in order to use the CLI, you must first set your <a href="https://developer.monday.com/api-reference/docs/authentication#accessing-api-tokens" target="_blank">API token</a> using the [`mapps init`](🔗) command.

# Installation



# Global flags

Global flagDescription
`--print-command`Prints the command that was executed (optional).
`--verbose`Prints advanced logs (optional).

# Commands

## `mapps init`

The `mapps init` command initializes the mapps config file (i.e., ".mappsrc"). You can use this command to add your <a href="https://developer.monday.com/api-reference/docs/authentication#accessing-api-tokens" target="_blank">API token</a> to access the CLI.

### Flags

Long flagShort flagDescription
`--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 <a href="https://developer.monday.com/api-reference/docs/authentication#accessing-api-tokens" target="_blank">API access token</a>.

### Example



## `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``-a`The app's unique identifier.
`--port``-p`The port to forward tunnel traffic to. The default is _8080_.

### Example



## `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``-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:list`

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

### Flags

Long flagShort flagDescription
`-appId``-a`The app's unique identifier.
`--appVersionId``-i`The app version's unique identifier.

### Example



## `mapps app-version:builds`

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

### Flags

Long flagShort flagDescription
`--appVersionId``-i`The app's unique identifier.

### Example



## `mapps app-version:list`

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

### Flags

Long flagShort flagDescription
`--appId``-i`The app's unique identifier.

### Example



## `mapps app:list`

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

### Example



## `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``-r`Refreshes the cache (ignores displaying instructions).

### Example



## `mapps code:env`

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

### Flags

Long flagShort flagDescription
`--appId``-i`The app's unique identifier.
`--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`).

### Example



## `mapps code:logs`

The `mapps code:logs` command streams logs.

### Flags

Long flagShort flagDescription
`--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).

### Example



## `mapps code:push`

The `mapps code:push` command pushes your project to be hosted on monday-code.

### Flags

Long flagShort flagDescription
`--directoryPath``-d`The project's directory path. If excluded, the working directory will be used.
`--appVersionId``-i`The app version's unique identifier.

### Example



## `mapps code:status`

The `mapps code:status` command provides the status of a specific project hosted on monday-code.

### Flags

Long flagShort flagDescription
`--appVersionId``-i`The app version's unique identifier.

### Example



## `mapps help [COMMANDS]`

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

### Arguments

ArgumentDescription
`COMMANDS`The command to show help for.

### Flags

Long flagShort flagDescription
`--nested-commands``-n`Includes all nested commands in the output.

### Example



## `mapps storage:search`

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

Long flagShort flagDescription
`--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:export`

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

Long flagShort flagDescription
`--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