mondaycom / monday-apps-cli

A simple cli tool to accommodate monday.com apps development for the monday-code eco-system

monday-apps-cli

monday.com cli tool for monday apps management.

• Usage
• Commands

Usage

$ npm install -g @mondaycom/apps-cli
$ mapps COMMAND
running command...
$ mapps (--version)
@mondaycom/apps-cli/2.3.5 darwin-arm64 node-v18.12.1
$ mapps --help [COMMAND]
USAGE
  $ mapps COMMAND
...

Commands

• mapps api:generate
• mapps app-features:build
• mapps app-features:create
• mapps app-features:list
• mapps app-version:builds
• mapps app-version:list
• mapps app:create
• mapps app:deploy
• mapps app:list
• mapps autocomplete [SHELL]
• mapps code:env
• mapps code:logs
• mapps code:push
• mapps code:status
• mapps help [COMMANDS]
• mapps init
• mapps storage:export
• mapps storage:search
• mapps tunnel:create

mapps api:generate

Prepares your environment for custom queries development. run it from your root directory!

USAGE
  $ mapps api:generate

DESCRIPTION
  Prepares your environment for custom queries development. run it from your root directory!
  Creates all neccesary files and scripts
  to start working with custom api queries and mutations.
  Read the documentation at
  [@mondaydotcomorg/setup-api](https://github.com/mondaycom/monday-graphql-api/tree/main/packages/setup-api)

See code: src/commands/api/generate.ts

mapps app-features:build

Create an app feature build.

USAGE
  $ mapps app-features:build [--verbose] [--print-command] [-a <value>] [-i <value>] [-d <value>] [-t
    custom_url|monday_code|monday_code_cdn] [-u <value>]

FLAGS
  -a, --appId=<value>         Please enter app id:
  -d, --appFeatureId=<value>  Please enter the app feature id of your app:
  -i, --appVersionId=<value>  Please enter the app version id of your app:
  -t, --buildType=<option>    Build type
                              <options: custom_url|monday_code|monday_code_cdn>
  -u, --customUrl=<value>     Custom url

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  Create an app feature build.

EXAMPLES
  $ mapps app-features:build -a APP_ID -i APP_VERSION_ID -d APP_FEATURE_ID  -t BUILD_TYPE -u CUSTOM_URL

See code: src/commands/app-features/build.ts

mapps app-features:create

Create an app feature.

USAGE
  $ mapps app-features:create [--verbose] [--print-command] [-a <value>] [-i <value>] [-t <value>] [-n <value>]

FLAGS
  -a, --appId=<value>         Please enter app id:
  -i, --appVersionId=<value>  Please enter the app version id of your app:
  -n, --featureName=<value>   Feature name
  -t, --featureType=<value>   Feature type

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  Create an app feature.

EXAMPLES
  $ mapps app-features:create -a APP_ID -i APP_VERSION_ID -t APP-FEATURE-TYPE

See code: src/commands/app-features/create.ts

mapps app-features:list

List all features for a specific app version.

USAGE
  $ mapps app-features:list [--verbose] [--print-command] [-a <value>] [-i <value>]

FLAGS
  -a, --appId=<value>         Please enter app id:
  -i, --appVersionId=<value>  Please enter the app version id of your app:

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  List all features for a specific app version.

EXAMPLES
  $ mapps app-features:list -a APP_ID -i APP_VERSION_ID

See code: src/commands/app-features/list.ts

mapps app-version:builds

List all builds for a specific app version

USAGE
  $ mapps app-version:builds [--verbose] [--print-command] [-i <value>]

FLAGS
  -i, --appVersionId=<value>  Please enter the app version id of your app:

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  List all builds for a specific app version

EXAMPLES
  $ mapps app-version:builds -i APP_VERSION_ID

See code: src/commands/app-version/builds.ts

mapps app-version:list

List all versions for a specific app.

USAGE
  $ mapps app-version:list [--verbose] [--print-command] [-i <value>]

FLAGS
  -i, --appId=<value>  Please enter app id:

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  List all versions for a specific app.

EXAMPLES
  $ mapps app-version:list

See code: src/commands/app-version/list.ts

mapps app:create

Create an app.

USAGE
  $ mapps app:create [--verbose] [--print-command] [-n <value>] [-d <value>]

FLAGS
  -d, --targetDir=<value>  Directory to create the app in.
  -n, --name=<value>       Name your new app.

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  Create an app.

EXAMPLES
  $ mapps app:create

  $ mapps app:create -n NEW_APP_NAME

See code: src/commands/app/create.ts

mapps app:deploy

Deploy an app using manifest file.

USAGE
  $ mapps app:deploy [--verbose] [--print-command] [-d <value>] [-a <value>] [-v <value>] [-f]

FLAGS
  -a, --appId=<value>          App id (will use the latest draft version)
  -d, --directoryPath=<value>  Directory path of you project in your machine. If not included will use the current
                               working directory.
  -f, --force                  Force push to latest version (draft or live)
  -v, --appVersionId=<value>   App version id

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  Deploy an app using manifest file.

EXAMPLES
  $ mapps app:deploy

See code: src/commands/app/deploy.ts

mapps app:list

List all apps for a specific user.

USAGE
  $ mapps app:list [--verbose] [--print-command]

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  List all apps for a specific user.

EXAMPLES
  $ mapps app:list

See code: src/commands/app/list.ts

mapps autocomplete [SHELL]

Display autocomplete installation instructions.

USAGE
  $ mapps autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  Display autocomplete installation instructions.

EXAMPLES
  $ mapps autocomplete

  $ mapps autocomplete bash

  $ mapps autocomplete zsh

  $ mapps autocomplete powershell

  $ mapps autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

mapps code:env

Manage environment variables for your app hosted on monday-code.

USAGE
  $ mapps code:env [--verbose] [--print-command] [-i <value>] [-m list-keys|set|delete] [-k <value>] [-v
    <value>]

FLAGS
  -i, --appId=<value>  The id of the app to manage environment variables for
  -k, --key=<value>    variable key [required for set and delete]]
  -m, --mode=<option>  management mode
                       <options: list-keys|set|delete>
  -v, --value=<value>  variable value [required for set]

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  Manage environment variables for your app hosted on monday-code.

EXAMPLES
  $ mapps code:env

See code: src/commands/code/env.ts

mapps code:logs

Stream logs

USAGE
  $ mapps code:logs [--verbose] [--print-command] [-i <value>] [-t <value>] [-s <value>] [-f <value>] [-e
    <value>] [-r <value>]

FLAGS
  -e, --logsEndDate=<value>        End date (MM/DD/YYYY HH:mm) e.g. "03/25/1983 16:45" [supported only if
                                   eventSource=live]
  -f, --logsStartDate=<value>      Start date (MM/DD/YYYY HH:mm) e.g. "03/24/1983 15:45" [supported only if
                                   eventSource=live]
  -i, --appVersionId=<value>       Please enter the app version id of your app:
  -r, --logSearchFromText=<value>  text: a text in regex that will be searched among the logs text [supported only if
                                   eventSource=live]
  -s, --eventSource=<value>        Source: "live" for live events, "History" for fetching events from the past
  -t, --logsType=<value>           Logs type: "http" for http events, "console" for stdout

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  Stream logs

EXAMPLES
  $ mapps code:logs -i APP_VERSION_ID -t LOGS_TYPE

See code: src/commands/code/logs.ts

mapps code:push

Push your project to get hosted on monday-code.

USAGE
  $ mapps code:push [--verbose] [--print-command] [-d <value>] [-a <value>] [-i <value>] [-f]

FLAGS
  -a, --appId=<value>          Please enter app id:
  -d, --directoryPath=<value>  Directory path of you project in your machine. If not included will use the current
                               working directory.
  -f, --force                  Force push to live version
  -i, --appVersionId=<value>   Please enter the app version id of your app:

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  Push your project to get hosted on monday-code.

EXAMPLES
  $ mapps code:push -d PROJECT DIRECTORY PATH -i APP_VERSION_ID_TO_PUSH

  $ mapps code:push -i APP_VERSION_ID_TO_PUSH

  $ mapps code:push -a APP_ID_TO_PUSH

See code: src/commands/code/push.ts

mapps code:status

Status of a specific project hosted on monday-code.

USAGE
  $ mapps code:status [--verbose] [--print-command] [-i <value>]

FLAGS
  -i, --appVersionId=<value>  Please enter the app version id of your app:

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  Status of a specific project hosted on monday-code.

EXAMPLES
  $ mapps code:status -i APP_VERSION_ID

See code: src/commands/code/status.ts

mapps help [COMMANDS]

Display help for mapps.

USAGE
  $ mapps help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for mapps.

See code: @oclif/plugin-help

mapps init

Initialize mapps config file - ".mappsrc".

USAGE
  $ mapps init [--verbose] [--print-command] [-t <value>] [-l]

FLAGS
  -l, --local          create the configuration file locally, in the current project working directory
  -t, --token=<value>  monday.com api access token (https://developer.monday.com/api-reference/docs/authentication)

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  Initialize mapps config file - ".mappsrc".

EXAMPLES
  $ mapps init -t SECRET_TOKEN

See code: src/commands/init/index.ts

mapps storage:export

Export all keys and values stored on monday for a specific customer account.

USAGE
  $ mapps storage:export [--verbose] [--print-command] [-a <value>] [-c <value>] [-f <value>] [-d <value>]

FLAGS
  -a, --appId=<value>            Select the app that you wish to retrieve the key for
  -c, --clientAccountId=<value>  Client account number.
  -d, --fileDirectory=<value>    Optional, file path.
  -f, --fileFormat=<value>       Optional, file format "CSV" or "JSON" (the default value is "JSON").

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  Export all keys and values stored on monday for a specific customer account.

EXAMPLES
  $ mapps storage:export -a APP_ID -c CLIENT_ACCOUNT_ID -d FILE_FULL_PATH -f FILE_FORMAT

See code: src/commands/storage/export.ts

mapps storage:search

Search keys and values stored on monday for a specific customer account.

USAGE
  $ mapps storage:search [--verbose] [--print-command] [-a <value>] [-c <value>] [-t <value>]

FLAGS
  -a, --appId=<value>            Select the app that you wish to retrieve the key for
  -c, --clientAccountId=<value>  Client account number.
  -t, --term=<value>             Term to search for.

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  Search keys and values stored on monday for a specific customer account.

EXAMPLES
  $ mapps storage:search -a APP_ID -c CLIENT_ACCOUNT_ID -t TERM

See code: src/commands/storage/search.ts

mapps tunnel:create

Create a networking tunnel to publicly expose code running on the local machine.

USAGE
  $ mapps tunnel:create [--verbose] [--print-command] [-p <value>] [-a <value>]

FLAGS
  -a, --appId=<value>  Specify an app id to get a unique tunnel domain for this app.
  -p, --port=<value>   [default: 8080] Port to forward tunnel traffic to.

GLOBAL FLAGS
  --print-command  Print the command that was executed (optional).
  --verbose        Print advanced logs (optional).

DESCRIPTION
  Create a networking tunnel to publicly expose code running on the local machine.

EXAMPLES
  $ mapps tunnel:create

  $ mapps tunnel:create -p PORT_FOR_TUNNEL

  $ mapps tunnel:create -a APP_ID_FOR_TUNNEL

  $ mapps tunnel:create -p PORT_FOR_TUNNEL -a APP_ID_FOR_TUNNEL

See code: src/commands/tunnel/create.ts

monday-apps-cli's Issues

HTTP error pushing Go example from local

[15:11:25.077] DEBUG: * Domain: https://monday-apps-ms.monday.com *
[15:11:26.075] DEBUG: api_service
    res: GET: https://monday-apps-ms.monday.com/api/apps - 200
? Select an app 10131502 | New App
[15:11:34.737] DEBUG: api_service
    res: GET: https://monday-apps-ms.monday.com/api/apps/10131502/versions - 200
? Select an app version 10201446 | 1.0.0 | New App |
 draft
[15:11:38.095] DEBUG: push code to appVersionId: 10201446
⠋ Build asset to deploy
[15:11:38.127] DEBUG: Directory path not provided. using current directory: /Users/brett/work_projects/m
⠋ Build asset to deploy
  › Building asset to deploy from
    "/Users/brett/work_projects/monday-code-quicksta
    rts/quickstart-go" directory
[15:11:38.128] DEBUG: create_archive - Check directory exists
    directoryPath: "/Users/brett/work_projects/monday-code-quickstarts/quickstart-go"
[15:11:38.129] DEBUG: ignore_files_for_archive - Searching for .mappsignore file
[15:11:38.130] DEBUG: ignore_files_for_archive - Searching for .gitignore file
[15:11:38.131] DEBUG: ignore_files_for_archive - No ignore files found, you can use .gitignore or
    .mappsignore to exclude some of the folders and files in your project
[15:11:38.131] DEBUG: archive - Starting
    directoryPath: "/Users/brett/work_projects/monday-code-quickstarts/quickstart-go"
    archivePath: "/Users/brett/work_projects/monday-code-quickstarts/quickstart-go/code.tar.gz"
[15:11:38.133] DEBUG: archive - Initialized
[15:11:38.133] DEBUG: archive - Added paths to ignore
    0: "/Users/brett/work_projects/monday-code-quickstarts/quickstart-go/code.tar.gz"
    1: "**/code.tar.gz"
    2: ".git/**"
    3: ".env"
    4: "local-secure-storage.db.json"
✔ Build asset to deploy
⠏ Preparing environment
[15:11:48.150] ERROR: get_signed_storage_url
    err: {
      "type": "HttpError",
      "message": "Unexpected error occurred while communicating with the remote server",
      "stack":
          Error: Unexpected error occurred while communicating with the remote server
              at handleErrors (file:///opt/homebrew/lib/node_modules/@mondaycom/apps-cli/dist/services/api-service.js:50:15)
              at execute (file:///opt/homebrew/lib/node_modules/@mondaycom/apps-cli/dist/services/api-service.js:91:16)
              at async getSignedStorageUrl (file:///opt/homebrew/lib/node_modules/@mondaycom/apps-cli/dist/services/push-service.js:22:26)
              at async _Task.prepareEnvironmentTask [as taskFn] (file:///opt/homebrew/lib/node_modules/@mondaycom/apps-cli/dist/services/push-service.js:139:39)
              at async _Task.run (file:///opt/homebrew/lib/node_modules/@mondaycom/apps-cli/node_modules/listr2/dist/index.js:1965:11)
✔ Build asset to deploy
✖ Unexpected error occurred while communicating
  with the remote server
[15:11:48.153] ERROR: code_push
    err: {
      "type": "HttpError",
      "message": "Unexpected error occurred while communicating with the remote server",
      "stack":
          Error: Unexpected error occurred while communicating with the remote server
              at handleErrors (file:///opt/homebrew/lib/node_modules/@mondaycom/apps-cli/dist/services/api-service.js:50:15)
              at execute (file:///opt/homebrew/lib/node_modules/@mondaycom/apps-cli/dist/services/api-service.js:91:16)
              at async getSignedStorageUrl (file:///opt/homebrew/lib/node_modules/@mondaycom/apps-cli/dist/services/push-service.js:22:26)
              at async _Task.prepareEnvironmentTask [as taskFn] (file:///opt/homebrew/lib/node_modules/@mondaycom/apps-cli/dist/services/push-service.js:139:39)
              at async _Task.run (file:///opt/homebrew/lib/node_modules/@mondaycom/apps-cli/node_modules/listr2/dist/index.js:1965:11)
      "description": "An error."
    } 

Hey all,
I have run MAPPS init and put in my api key. Have cloned the go project. Made a app and installed cli. Ran push command and getting error above. From the go hello world run on defaults, no env added.

Multiple issues with ignoring files on packaging step

1. Files in the root directory of the project, which marked as ignored in .gitignore/.mappsignore are still being packaged.
2. In windows, the cli ignores the ignore files completely.

Postinstall patch fails on GitHub Actions

Problem

When installing XXXX on GitHub Actions, the postinstall patch of XXX package fails. I assume this happens because of hard coded path of node_modules location in the patch.

How to Reproduce

GitHub Action

jobs:
  build:
    runs-on: ubuntu-latest
    name: Build
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - uses: actions/setup-node@v4
        with:
          node-version: 18.19.1

      - name: Install
        run: |
          npm i

This fails after installation:

npm ERR! code 1
npm ERR! path /home/runner/work/XXX/node_modules/@mondaycom/apps-cli
npm ERR! command failed
npm ERR! command sh -c patch-package
npm ERR! patch-package 8.0.0
npm ERR! Applying patches...
npm ERR! Error: Patch file found for package parse-gitignore which is not present at node_modules/parse-gitignore
npm ERR! ---
npm ERR! patch-package finished with 1 error(s).
npm ERR! A complete log of this run can be found in: /home/runner/.npm/_logs/2024-02-27T22_24_[43](https://github.com/gp42/XXX/actions/runs/8072172997/job/22053350480#step:5:44)_979Z-debug-0.log

Workaround

As a workaround it is possible to do the following:

      - name: Install and build
        run: |
          npm i --ignore-scripts @mondaycom/apps-cli
          npm i