Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add api cli doc #90

Merged
merged 1 commit into from
Mar 20, 2024
Merged

add api cli doc #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 20 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ $ npm install -g @mondaycom/apps-cli
$ mapps COMMAND
running command...
$ mapps (--version)
@mondaycom/apps-cli/2.3.4 darwin-arm64 node-v18.12.1
@mondaycom/apps-cli/2.3.5 darwin-arm64 node-v18.12.1
$ mapps --help [COMMAND]
USAGE
$ mapps COMMAND
Expand Down Expand Up @@ -59,9 +59,11 @@ 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](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.4/src/commands/api/generate.ts)_
_See code: [src/commands/api/generate.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/api/generate.ts)_

## `mapps app-features:build`

Expand Down Expand Up @@ -91,7 +93,7 @@ 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/v2.3.4/src/commands/app-features/build.ts)_
_See code: [src/commands/app-features/build.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/app-features/build.ts)_

## `mapps app-features:create`

Expand All @@ -118,7 +120,7 @@ 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/v2.3.4/src/commands/app-features/create.ts)_
_See code: [src/commands/app-features/create.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/app-features/create.ts)_

## `mapps app-features:list`

Expand All @@ -143,7 +145,7 @@ 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/v2.3.4/src/commands/app-features/list.ts)_
_See code: [src/commands/app-features/list.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/app-features/list.ts)_

## `mapps app-version:builds`

Expand All @@ -167,7 +169,7 @@ 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/v2.3.4/src/commands/app-version/builds.ts)_
_See code: [src/commands/app-version/builds.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/app-version/builds.ts)_

## `mapps app-version:list`

Expand All @@ -191,7 +193,7 @@ EXAMPLES
$ mapps app-version:list
```

_See code: [src/commands/app-version/list.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.4/src/commands/app-version/list.ts)_
_See code: [src/commands/app-version/list.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/app-version/list.ts)_

## `mapps app:create`

Expand All @@ -218,7 +220,7 @@ EXAMPLES
$ mapps app:create -n NEW_APP_NAME
```

_See code: [src/commands/app/create.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.4/src/commands/app/create.ts)_
_See code: [src/commands/app/create.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/app/create.ts)_

## `mapps app:deploy`

Expand Down Expand Up @@ -246,7 +248,7 @@ EXAMPLES
$ mapps app:deploy
```

_See code: [src/commands/app/deploy.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.4/src/commands/app/deploy.ts)_
_See code: [src/commands/app/deploy.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/app/deploy.ts)_

## `mapps app:list`

Expand All @@ -267,7 +269,7 @@ EXAMPLES
$ mapps app:list
```

_See code: [src/commands/app/list.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.4/src/commands/app/list.ts)_
_See code: [src/commands/app/list.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/app/list.ts)_

## `mapps autocomplete [SHELL]`

Expand Down Expand Up @@ -327,7 +329,7 @@ EXAMPLES
$ mapps code:env
```

_See code: [src/commands/code/env.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.4/src/commands/code/env.ts)_
_See code: [src/commands/code/env.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/code/env.ts)_

## `mapps code:logs`

Expand Down Expand Up @@ -360,7 +362,7 @@ 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/v2.3.4/src/commands/code/logs.ts)_
_See code: [src/commands/code/logs.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/code/logs.ts)_

## `mapps code:push`

Expand Down Expand Up @@ -392,7 +394,7 @@ EXAMPLES
$ mapps code:push -a APP_ID_TO_PUSH
```

_See code: [src/commands/code/push.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.4/src/commands/code/push.ts)_
_See code: [src/commands/code/push.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/code/push.ts)_

## `mapps code:status`

Expand All @@ -416,7 +418,7 @@ EXAMPLES
$ mapps code:status -i APP_VERSION_ID
```

_See code: [src/commands/code/status.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.4/src/commands/code/status.ts)_
_See code: [src/commands/code/status.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/code/status.ts)_

## `mapps help [COMMANDS]`

Expand Down Expand Up @@ -461,7 +463,7 @@ EXAMPLES
$ mapps init -t SECRET_TOKEN
```

_See code: [src/commands/init/index.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.4/src/commands/init/index.ts)_
_See code: [src/commands/init/index.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/init/index.ts)_

## `mapps storage:export`

Expand All @@ -488,7 +490,7 @@ 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/v2.3.4/src/commands/storage/export.ts)_
_See code: [src/commands/storage/export.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/storage/export.ts)_

## `mapps storage:search`

Expand All @@ -514,7 +516,7 @@ 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/v2.3.4/src/commands/storage/search.ts)_
_See code: [src/commands/storage/search.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/storage/search.ts)_

## `mapps tunnel:create`

Expand Down Expand Up @@ -545,5 +547,5 @@ EXAMPLES
$ 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/v2.3.4/src/commands/tunnel/create.ts)_
_See code: [src/commands/tunnel/create.ts](https://github.com/mondaycom/monday-apps-cli/blob/v2.3.5/src/commands/tunnel/create.ts)_
<!-- commandsstop -->
2 changes: 1 addition & 1 deletion bin/minimal-package.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export default { name: "@mondaycom/apps-cli", version: "2.3.4" };
export default { name: "@mondaycom/apps-cli", version: "2.3.5" };
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@mondaycom/apps-cli",
"version": "2.3.4",
"version": "2.3.5",
"description": "A cli tool to manage apps (and monday-code projects) in monday.com",
"author": "monday.com Apps Team",
"type": "module",
Expand Down
3 changes: 2 additions & 1 deletion src/commands/api/generate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ export default class ApiGenerate extends BaseCommand {

static 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.`;
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)`;

async run() {
try {
Expand Down
Loading