https://github.com/mondaycom/monday-apps-cli
A simple cli tool to accommodate monday.com apps development for the monday-code eco-system
https://github.com/mondaycom/monday-apps-cli
Last synced: 2 months ago
JSON representation
A simple cli tool to accommodate monday.com apps development for the monday-code eco-system
- Host: GitHub
- URL: https://github.com/mondaycom/monday-apps-cli
- Owner: mondaycom
- License: mit
- Created: 2022-11-23T08:55:00.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T14:05:08.000Z (12 months ago)
- Last Synced: 2024-05-29T02:52:11.016Z (12 months ago)
- Language: TypeScript
- Size: 1.61 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
monday-apps-cli
=================
monday.com cli tool for monday apps management.
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g @mondaycom/apps-cli
$ mapps COMMAND
running command...
$ mapps (--version)
@mondaycom/apps-cli/4.4.1 darwin-arm64 node-v20.12.2
$ mapps --help [COMMAND]
USAGE
$ mapps COMMAND
...
```
# Commands
* [`mapps api:generate`](#mapps-apigenerate)
* [`mapps app-features:build`](#mapps-app-featuresbuild)
* [`mapps app-features:create`](#mapps-app-featurescreate)
* [`mapps app-features:list`](#mapps-app-featureslist)
* [`mapps app-version:builds`](#mapps-app-versionbuilds)
* [`mapps app-version:list`](#mapps-app-versionlist)
* [`mapps app:create`](#mapps-appcreate)
* [`mapps app:deploy`](#mapps-appdeploy)
* [`mapps app:list`](#mapps-applist)
* [`mapps autocomplete [SHELL]`](#mapps-autocomplete-shell)
* [`mapps code:env`](#mapps-codeenv)
* [`mapps code:logs`](#mapps-codelogs)
* [`mapps code:push`](#mapps-codepush)
* [`mapps code:secret`](#mapps-codesecret)
* [`mapps code:status`](#mapps-codestatus)
* [`mapps help [COMMANDS]`](#mapps-help-commands)
* [`mapps init`](#mapps-init)
* [`mapps storage:export`](#mapps-storageexport)
* [`mapps storage:search`](#mapps-storagesearch)
* [`mapps tunnel:create`](#mapps-tunnelcreate)
## `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 necessary 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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/src/commands/api/generate.ts)_
## `mapps app-features:build`
Create an app feature build.
```
USAGE
$ mapps app-features:build [--verbose] [--print-command] [-a ] [-i ] [-d ] [-t
custom_url|monday_code|monday_code_cdn] [-u ]
FLAGS
-a, --appId= Please enter app id:
-d, --appFeatureId= Please enter the app feature id of your app:
-i, --appVersionId= Please enter the app version id of your app:
-t, --buildType= Build type
-u, --customUrl= 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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/src/commands/app-features/build.ts)_
## `mapps app-features:create`
Create an app feature.
```
USAGE
$ mapps app-features:create [--verbose] [--print-command] [-a ] [-i ] [-t ] [-n ]
FLAGS
-a, --appId= Please enter app id:
-i, --appVersionId= Please enter the app version id of your app:
-n, --featureName= Feature name
-t, --featureType= 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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/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 ] [-i ]
FLAGS
-a, --appId= Please enter app id:
-i, --appVersionId= 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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/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 ]
FLAGS
-i, --appVersionId= 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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/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 ]
FLAGS
-i, --appId= 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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/src/commands/app-version/list.ts)_
## `mapps app:create`
Create an app.
```
USAGE
$ mapps app:create [--verbose] [--print-command] [-n ] [-d ]
FLAGS
-d, --targetDir= Directory to create the app in.
-n, --name= 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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/src/commands/app/create.ts)_
## `mapps app:deploy`
Deploy an app using manifest file.
```
USAGE
$ mapps app:deploy [--verbose] [--print-command] [-d ] [-a ] [-v ] [-f] [-z us|eu|au]
FLAGS
-a, --appId= App id (will use the latest draft version)
-d, --directoryPath= 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= App version id
-z, --region= Region to use
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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/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](https://github.com/oclif/plugin-autocomplete/blob/v3.0.5/src/commands/autocomplete/index.ts)_
## `mapps code:env`
Manage environment variables for your app hosted on monday-code.
```
USAGE
$ mapps code:env [--verbose] [--print-command] [-i ] [-m list-keys|set|delete] [-k ] [-v
] [-z us|eu|au]
FLAGS
-i, --appId= The id of the app to manage environment variables for
-k, --key= variable key [required for set and delete]]
-m, --mode= management mode
-v, --value= variable value [required for set]
-z, --region= Region to use
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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/src/commands/code/env.ts)_
## `mapps code:logs`
Stream logs
```
USAGE
$ mapps code:logs [--verbose] [--print-command] [-i ] [-t ] [-s ] [-f ] [-e
] [-r ] [-z us|eu|au]
FLAGS
-e, --logsEndDate= End date (MM/DD/YYYY HH:mm) e.g. "03/25/1983 16:45" [supported only if
eventSource=live]
-f, --logsStartDate= Start date (MM/DD/YYYY HH:mm) e.g. "03/24/1983 15:45" [supported only if
eventSource=live]
-i, --appVersionId= Please enter the app version id of your app:
-r, --logSearchFromText= text: a text in regex that will be searched among the logs text [supported only if
eventSource=live]
-s, --eventSource= Source: "live" for live events, "History" for fetching events from the past
-t, --logsType= Logs type: "http" for http events, "console" for stdout
-z, --region= Region to use
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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/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 ] [-a ] [-i ] [-f] [-z us|eu|au]
FLAGS
-a, --appId= Please enter app id:
-d, --directoryPath= 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= Please enter the app version id of your app:
-z, --region= Region to use
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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/src/commands/code/push.ts)_
## `mapps code:secret`
Manage secret variables for your app hosted on monday-code.
```
USAGE
$ mapps code:secret [--verbose] [--print-command] [-i ] [-m list-keys|set|delete] [-k ] [-v
] [-z us|eu|au]
FLAGS
-i, --appId= The id of the app to manage secret variables for
-k, --key= variable key [required for set and delete]]
-m, --mode= management mode
-v, --value= variable value [required for set]
-z, --region= Region to use
GLOBAL FLAGS
--print-command Print the command that was executed (optional).
--verbose Print advanced logs (optional).
DESCRIPTION
Manage secret variables for your app hosted on monday-code.
EXAMPLES
$ mapps code:secret
```
_See code: [src/commands/code/secret.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/src/commands/code/secret.ts)_
## `mapps code:status`
Status of a specific project hosted on monday-code.
```
USAGE
$ mapps code:status [--verbose] [--print-command] [-i ] [-z us|eu|au]
FLAGS
-i, --appVersionId= Please enter the app version id of your app:
-z, --region= Region to use
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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/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](https://github.com/oclif/plugin-help/blob/v6.0.12/src/commands/help.ts)_
## `mapps init`
Initialize mapps config file - ".mappsrc".
```
USAGE
$ mapps init [--verbose] [--print-command] [-t ] [-l]
FLAGS
-l, --local create the configuration file locally, in the current project working directory
-t, --token= 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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/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 ] [-c ] [-f ] [-d ]
FLAGS
-a, --appId= Select the app that you wish to retrieve the key for
-c, --clientAccountId= Client account number.
-d, --fileDirectory= Optional, file path.
-f, --fileFormat= 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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/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 ] [-c ] [-t ]
FLAGS
-a, --appId= Select the app that you wish to retrieve the key for
-c, --clientAccountId= Client account number.
-t, --term= 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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/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 ] [-a ]
FLAGS
-a, --appId= Specify an app id to get a unique tunnel domain for this app.
-p, --port= [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](https://github.com/mondaycom/monday-apps-cli/blob/v4.4.1/src/commands/tunnel/create.ts)_