Interfejs wiersza poleceń (CLI)
CLI monday.com pozwala korzystać z frameworka aplikacji za pomocą zestawu predefiniowanych poleceń, które wykonują różne operacje. W tym artykule znajdziesz instrukcje instalacji CLI oraz opis obsługiwanych poleceń. Możesz też przejść bezpośrednio do CLI tutaj.
Instalacja
Aby zacząć korzystać z CLI, najpierw zainstaluj je za pomocą następującego polecenia:
$ npm install -g @mondaycom/apps-cli
Po zainstalowaniu CLI użyj polecenia mapps init, aby dodać token API:
$ mapps init -t <SECRET_TOKEN>
Polecenia
mapps api:generatemapps app-features:buildmapps app-features:createmapps app-features:listmapps app-version:buildsmapps app-version:listmapps app:createmapps app:deploymapps app:listmapps app:promotemapps app:scaffold [DESTINATION] [PROJECT]mapps autocomplete [SHELL]mapps code:envmapps code:logsmapps code:pushmapps code:reportmapps code:secretmapps code:statusmapps database:connection-stringmapps help [COMMANDS]mapps initmapps manifest:exportmapps manifest:importmapps scheduler:createmapps scheduler:deletemapps scheduler:listmapps scheduler:runmapps scheduler:updatemapps storage:exportmapps storage:remove-datamapps storage:searchmapps tunnel:create
Flagi globalne
Poniższe flagi globalne są opcjonalne i możesz ich użyć z dowolnym poleceniem.
| Flaga globalna | Opis |
|---|---|
--print-command |
Wyświetla wykonane polecenie. |
--verbose |
Wyświetla szczegółowe logi. |
mapps api:generate
Polecenie mapps api:generate przygotowuje środowisko do tworzenia niestandardowych zapytań, tworząc wszystkie niezbędne pliki i skrypty. Uruchom je z katalogu głównego!
Przykład
$ mapps api:generate
mapps app-features:build
Polecenie mapps app-features:build tworzy nową kompilację funkcji aplikacji. Pamiętaj, że obecnie obsługuje tylko typy kompilacji custom_url i monday_code.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-a |
--appId |
Unikalny identyfikator aplikacji. |
-d |
--appFeatureId |
Unikalny identyfikator funkcji aplikacji. |
-i |
--appVersionId |
Unikalny identyfikator wersji aplikacji. |
-t |
--buildType |
Typ kompilacji: custom_url lub monday_code. |
-u |
--customUrl |
Niestandardowy adres URL kompilacji aplikacji (jeśli dotyczy). |
Przykład
$ 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
Polecenie mapps app-features:create tworzy nową funkcję aplikacji.
Flagi
| Flaga krótka | Flaga długa | Opis | Akceptowane wartości |
|---|---|---|---|
-a |
--appId |
Unikalny identyfikator aplikacji. | |
-i |
--appVersionId |
Unikalny identyfikator wersji aplikacji. | |
-n |
--featureName |
Nazwa funkcji. | |
-t |
--featureType |
Typ funkcji. |
|
mapps app-features:list
Polecenie mapps app-features:list wyświetla listę wszystkich funkcji dla określonej wersji aplikacji.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-a |
-appId |
Unikalny identyfikator aplikacji. |
-i |
--appVersionId |
Unikalny identyfikator wersji aplikacji. |
Przykład
$ mapps app-features:list
// or
$ mapps app-features:list -a 123456789 -i 987654321
mapps app-version:builds
Polecenie mapps app-version:builds wyświetla listę wszystkich kompilacji dla określonej wersji aplikacji.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-i |
--appVersionId |
Unikalny identyfikator wersji. |
$ mapps app-version:builds -t 987654321
mapps app-version:list
Polecenie mapps app-version:list wyświetla listę wszystkich wersji wybranej aplikacji.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-i |
--appId |
Unikalny identyfikator aplikacji. |
Przykład
$ mapps app-version:list -i 1234567890
mapps app:create
Polecenie mapps app:create tworzy aplikację.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-d |
--targetDir |
Katalog, w którym zostanie utworzona aplikacja. |
-n |
--name |
Nazwa nowej aplikacji. |
Przykład
$ mapps app:create -n NEW_APP_NAME
mapps app:deploy
Polecenie mapps app:deploy wdraża aplikację na podstawie pliku manifestu.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-a |
--appId |
Unikalny identyfikator aplikacji. |
-d |
--directoryPath |
Ścieżka do katalogu projektu. Jeśli jej nie podasz, zostanie użyty bieżący katalog roboczy. |
-f |
--force |
Wymusza przesłanie do najnowszej wersji (roboczej lub aktywnej). |
-v |
--appVersionId |
Unikalny identyfikator wersji. |
-z |
--region |
Region, którego chcesz użyć: us, au, eu lub il. |
Przykład
$ mapps app:deploy
mapps app:list
Polecenie mapps app:list wyświetla listę wszystkich aplikacji danego użytkownika.
Przykład
$ mapps app:list
mapps app:promote
Polecenie mapps app:promote publikuje roboczą wersję aplikacji jako aktywną.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-a |
--appId |
Unikalny identyfikator aplikacji. |
-i |
--appVersionId |
Unikalny identyfikator wersji aplikacji |
Przykład
$ mapps app:promote -i <APP_VERSION_ID> -a <APP_ID>
mapps app:scaffold [DESTINATION] [PROJECT]
Polecenie mapps app:scaffold [DESTINATION] [PROJECT] tworzy szkielet aplikacji monday na podstawie szablonu, instaluje zależności i automatycznie uruchamia projekt.
Argumenty
| Argument | Opis |
|---|---|
| DESTINATION | Katalog docelowy projektu utworzonego ze szkieletu. |
| PROJECT | Nazwa szablonu projektu, na podstawie którego ma powstać szkielet. |
Flagi
| Flaga krótka | Flaga długa | Opis | Uwagi |
|---|---|---|---|
-c |
--command |
Polecenie skryptu npm uruchamiane po instalacji. | Domyślnie: start |
-s |
--signingSecret |
Klucz podpisywania monday.com używany w konfiguracji .env. |
Przykład
$ mapps app:scaffold ./my-app slack-node --signingSecret YOUR_SECRET
mapps autocomplete [SHELL]
Polecenie mapps autocomplete [SHELL] wyświetla instrukcje instalacji autouzupełniania.
Argumenty
| Argument | Opis |
|---|---|
| SHELL | Typ powłoki: zsh, bash lub powershell. |
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-r |
--refresh-cache |
Odświeża pamięć podręczną (pomija wyświetlanie instrukcji). |
Przykład
$ mapps autocomplete bash
mapps code:env
Polecenie mapps code:env zarządza zmiennymi środowiskowymi aplikacji hostowanej w monday code.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-i |
--appId |
Identyfikator aplikacji. |
-k |
--key |
Klucz zmiennej (wymagany dla poleceń set i delete). |
-m |
--mode |
Tryb zarządzania: list-keys, set lub delete. |
-v |
--value |
Wartość zmiennej (wymagana dla polecenia set). |
-z |
--region |
Region, którego chcesz użyć: us, au, eu lub il. |
Przykład
$ mapps code:env -m set -k <KEY> -v <VALUE>
mapps code:logs
Polecenie mapps code:logs przesyła strumieniowo logi.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-e |
--logsEndDate |
Data końcowa logów (np. MM/DD/YYYY HH:mm). Obsługiwane tylko dla zdarzeń history. |
-f |
--logsStartDate |
Data początkowa logów (np. MM/DD/YYYY HH:mm). Obsługiwane tylko dla zdarzeń history. |
-i |
--appVersionId |
Identyfikator wersji aplikacji. |
-r |
--logSearchFromText |
Wyrażenie regularne, którego polecenie używa do wyszukiwania w logach. Obsługiwane tylko dla zdarzeń live. |
-s |
--eventSource |
Źródło logów: live (bieżące zdarzenia) lub history (zdarzenia z przeszłości). |
-t |
--logsType |
Typ logów: http (zdarzenia HTTP) lub console (stdout). |
-z |
--region |
Region, którego chcesz użyć: us, au, eu lub il. |
Przykład
$ mapps code:logs -i <APP_VERSION_ID> -t <LOGS_TYPE>
mapps code:push
Polecenie mapps code:push przesyła projekt, aby był hostowany w infrastrukturze monday.com.
Flagi
| Flaga krótka | Flaga długa | Opis | Uwagi |
|---|---|---|---|
-a |
--appId |
Identyfikator aplikacji. | |
-c |
--client-side |
Przesyła kod po stronie klienta do monday.com (wersja 4.6.0 lub nowsza). | Przesyła kod do naszej sieci CDN, aby skrócić czas ładowania i zmniejszyć opóźnienia (zalecane). Katalog musi zawierać plik index.html na najwyższym poziomie. |
-d |
--directoryPath |
Ścieżka do katalogu projektu. Jeśli jej nie podasz, zostanie użyty bieżący katalog roboczy. | Jeśli używasz bundlera, podaj ścieżkę do katalogu z kompilacją (np. "./dist"). |
-f |
--force |
Wymusza przesłanie do najnowszej wersji (roboczej lub aktywnej). | |
-i |
--appVersionId |
Identyfikator wersji aplikacji. | |
-s |
--security-scan |
Uruchamia skanowanie bezpieczeństwa, aby podczas wdrażania kodu znaleźć podatności w zależnościach. | |
-z |
--region |
Region, którego chcesz użyć: us, au, eu lub il. |
Przykład
$ mapps code:push -d <PROJECT BUILD DIRECTORY PATH> -i <APP_VERSION_ID_TO_PUSH>
mapps code:report
Polecenie mapps code:report pobiera raport ze skanowania bezpieczeństwa wdrożenia monday code.
Flagi
| Flaga krótka | Flaga długa | Opis | Uwagi |
|---|---|---|---|
-d |
--outputDir |
Katalog, w którym ma zostać zapisany raport. | Wymagane razem z flagą -o. |
-i |
--appVersionId |
Identyfikator wersji aplikacji. | |
-o |
--output |
Zapisuje pełny raport jako plik JSON. | |
-z |
--region |
Region, którego chcesz użyć: us, au, eu lub il. |
Przykład
$ mapps code:report -i APP_VERSION_ID -o -d /path/to/directory
mapps code:secret
Polecenie mapps code:secret zarządza zmiennymi tajnymi aplikacji hostowanej w monday-code. Jest dostępne tylko dla aplikacji monday code.
Flagi
| Flaga krótka | Flaga długa | Opis | Uwagi |
|---|---|---|---|
-i |
-appId |
Identyfikator aplikacji. | |
-k |
--key |
Klucz zmiennej. | Wymagany dla poleceń set i delete. |
-m |
--mode |
Tryb zarządzania: list-keys, set lub delete. |
|
-v |
--value |
Wartość zmiennej. | Wymagana dla polecenia set. |
-z |
--region |
Region, którego chcesz użyć: us, au, eu lub il. |
Przykład
$ mapps code:secret -m set -k <KEY> -v <VALUE>
mapps code:status
Polecenie mapps code:status wyświetla status konkretnego projektu hostowanego w monday-code. Jest dostępne tylko dla aplikacji monday code.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-i |
--appVersionId |
Identyfikator wersji aplikacji. |
-z |
--region |
Region, którego chcesz użyć: us, au, eu lub il. |
Przykład
$ mapps code:status -i <APP_VERSION_ID>
mapps database:connection-string
Polecenie mapps database:connection-string pobiera ciąg połączenia z bazą danych aplikacji.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-a |
--appId |
Identyfikator aplikacji. |
Przykład
$ mapps database:connection-string -a APP_ID
mapps help [COMMANDS]
Polecenie mapps help [COMMANDS] wyświetla pomoc dotyczącą mapps.
Argumenty
| Argument | Opis |
|---|---|
COMMANDS |
Polecenie, którego dotyczy pomoc. |
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-n |
--nested-commands |
Uwzględnia w wynikach wszystkie zagnieżdżone polecenia. |
Przykład
$ mapps help [COMMANDS] [-n]
mapps init
Polecenie mapps init inicjuje plik konfiguracyjny mapps (czyli .mappsrc). Użyj go, aby dodać token API i uzyskać dostęp do CLI.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-l |
--local |
Tworzy plik konfiguracyjny lokalnie, w bieżącym katalogu roboczym projektu. Użyj tej opcji, jeśli korzystasz z różnych tokenów dostępu w poszczególnych projektach. |
-t |
--token |
Token dostępu do API. |
Przykład
$ mapps init -t <SECRET_TOKEN>
mapps manifest:export
Polecenie mapps manifest:export eksportuje manifest aplikacji.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-a |
--appId |
Identyfikator aplikacji. |
-i |
--appVersionId |
Identyfikator wersji aplikacji. |
-p |
--manifestPath |
Ścieżka, do której mają zostać wyeksportowane pliki manifestu aplikacji. |
Przykład
$ mapps manifest:export -p ./exports
mapps manifest:import
Polecenie mapps manifest:import importuje manifest z opcjonalnymi zmiennymi szablonu.
Flagi
| Flaga krótka | Flaga długa | Opis | Uwagi |
|---|---|---|---|
-a |
--appId |
Identyfikator aplikacji. | Tworzy nową wersję roboczą. |
-i |
--appVersionId |
Identyfikator wersji aplikacji do zastąpienia. | |
-m |
--allowMissingVariables |
Zezwala na brakujące zmienne. | |
-n |
--newApp |
Tworzy nową aplikację. | |
-p |
--manifestPath |
Ścieżka do pliku manifestu aplikacji na komputerze. |
Przykład
$ mapps manifest:import --manifestPath ./manifest.json
mapps scheduler:create
Polecenie mapps scheduler:create tworzy nowe zaplanowane zadanie cron. Jest dostępne tylko dla aplikacji monday code.
Flagi
| Flaga krótka | Flaga długa | Opis | Uwagi |
|---|---|---|---|
-a |
--appId |
Identyfikator aplikacji. | |
-b |
--minBackoffDuration |
Minimalny czas oczekiwania między ponownymi próbami. | Wartość podaj w sekundach. Opcjonalne. Jeśli jej nie podasz, domyślnie wynosi 10 minut. |
-d |
--description |
Opis zaplanowanego zadania. | |
-n |
--name |
Nazwa zaplanowanego zadania. To unikalny identyfikator zadania w tej aplikacji. | Nazwa nie może zawierać spacji. Powinna być unikalna dla zadania, ale można ponownie użyć nazw usuniętych zadań. |
-r |
--maxRetries |
Maksymalna liczba ponownych prób dla nieudanych zadań. | Opcjonalne. |
-s |
--schedule |
Wyrażenie cron określające harmonogram zadania. | Czas jest podawany względem UTC. Użyj generatora wyrażeń cron, aby uzyskać poprawny format (np. Cronhub ). |
-t |
--timeout |
Limit czasu wykonania zadania. | Wartość podaj w sekundach. Opcjonalne. |
-u |
--targetUrl |
Ścieżka docelowego adresu URL zadania. | Musi zaczynać się od „/”. Będzie ścieżką względną względem /mndy-cronjob. |
-z |
--region |
Region, którego chcesz użyć: us, au lub eu. |
Przykład
$ 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
Polecenie mapps scheduler:delete usuwa zaplanowane zadanie cron. Jest dostępne tylko dla aplikacji monday code.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-a |
--appId |
Unikalny identyfikator aplikacji. |
-n |
--name |
Nazwa zaplanowanego zadania. |
-z |
--region |
Region, którego chcesz użyć: us, au lub eu. |
Przykład
$ mapps scheduler:delete -a APP_ID -n "my-job"
mapps scheduler:list
Polecenie mapps scheduler:list wyświetla listę wszystkich zaplanowanych zadań cron. Jest dostępne tylko dla aplikacji monday code.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-a |
--appId |
Unikalny identyfikator aplikacji. |
Przykład
$ mapps scheduler:list -a APP_ID
mapps scheduler:run
Polecenie mapps scheduler:run uruchamia zaplanowane zadanie cron. Możesz użyć go, aby uruchomić zadanie na żądanie zamiast czekać na kolejny zaplanowany termin. Jest dostępne tylko dla aplikacji monday code.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-a |
--appId |
Unikalny identyfikator aplikacji. |
-n |
--name |
Nazwa zaplanowanego zadania. |
-z |
--region |
Region, którego chcesz użyć: us, au lub eu. |
Przykład
$ mapps scheduler:run -a APP_ID -n "my-job"
mapps scheduler:update
Polecenie mapps scheduler:update aktualizuje zaplanowane zadanie cron. Jest dostępne tylko dla aplikacji monday code.
Flagi
| Flaga krótka | Flaga długa | Opis | Uwagi |
|---|---|---|---|
-a |
--appId |
Unikalny identyfikator aplikacji. | |
-b |
--minBackoffDuration |
Minimalny czas oczekiwania między ponownymi próbami. | Wartość podaj w sekundach. Opcjonalne. Jeśli jej nie podasz, domyślnie wynosi 10 minut. |
-d |
--description |
Opis zaplanowanego zadania. | |
-n |
--name |
Nazwa zaplanowanego zadania. To unikalny identyfikator zadania w tej aplikacji. | Nazwa nie może zawierać spacji. Powinna być unikalna dla zadania, ale można ponownie użyć nazw usuniętych zadań. |
-r |
--maxRetries |
Maksymalna liczba ponownych prób dla nieudanych zadań. | Opcjonalne. |
-s |
--schedule |
Wyrażenie cron określające harmonogram zadania. | Czas jest podawany względem UTC. Użyj generatora wyrażeń cron, aby uzyskać poprawny format (np. Cronhub). |
-t |
--timeout |
Limit czasu wykonania zadania. | Wartość podaj w sekundach. Opcjonalne. |
-u |
--targetUrl |
Ścieżka docelowego adresu URL zadania. | Musi zaczynać się od „/”. Będzie ścieżką względną względem /mndy-cronjob. |
-z |
--region |
Region, którego chcesz użyć: us, au lub eu. |
Przykład
$ mapps scheduler:update -a APP_ID -n "my-job" -d "This job will execute automatically." -r 3 -b 10 -t 60
mapps storage:export
Polecenie mapps storage:export eksportuje wszystkie klucze i wartości przechowywane w monday dla określonego konta klienta.
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-a |
--appId |
Aplikacja, z której ma zostać pobrany klucz. |
-c |
--clientAccountId |
Numer konta klienta. |
-d |
--fileDirectory |
Ścieżka do pliku. Opcjonalne. Jeśli jej nie podasz, zostanie użyty bieżący folder. |
-f |
--fileFormat |
Format pliku: CSV lub JSON. Opcjonalne; domyślnie używany jest format JSON. |
Przykład
$ mapps storage:export
// or
$ mapps storage:export -a 12345678790 -c 9876543210
mapps storage:remove-data
Polecenie mapps storage:remove-data usuwa wszystkie dane z pamięci masowej dla określonego konta klienta.
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-a |
--appId |
Identyfikator aplikacji. |
-c |
--clientAccountId |
Numer konta klienta. |
-f |
--force |
Pomija etap potwierdzenia. |
Przykład
$ mapps storage:remove-data -a 1234567890 -c 9876543210
mapps storage:search
Polecenie mapps storage:search wyszukuje klucze i wartości przechowywane w monday dla określonego konta klienta.
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-a |
--appId |
Aplikacja, z której ma zostać pobrany klucz. |
-c |
--clientAccountId |
Numer konta klienta. |
-t |
--term |
Wyszukiwany termin. |
Przykład
$ mapps storage:search
// or
$ mapps storage:search -a 1234567890 -c 9876543210 -t keyword
mapps tunnel:create
Polecenie mapps tunnel:create tworzy tunel sieciowy, który udostępnia publicznie kod uruchomiony na komputerze lokalnym.
Flagi
| Flaga krótka | Flaga długa | Opis |
|---|---|---|
-a |
--appId |
Unikalny identyfikator aplikacji, dla której ma zostać utworzona unikalna domena tunelu. |
-p |
--port |
Port, na który ma być przekierowywany ruch tunelu. Domyślnie: 8080. |
Przykład
$ mapps tunnel:create -p 3000 -a 123456789