appwrite-cli 0.14.0 → 0.17.0

package/lib/commands/database.js

@@ -1,7 +1,10 @@
 const fs = require('fs');
+const pathLib = require('path');
+const tar = require("tar");
+const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
+const { getAllFiles } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -648,7 +651,7 @@ const databaseCreateDocument = async ({ collectionId, documentId, data, read, wr
     }
 
     if (typeof data !== 'undefined') {
-        payload['data'] = data;
+        payload['data'] = JSON.parse(data);
     }
 
     if (typeof read !== 'undefined') {
@@ -703,7 +706,7 @@ const databaseUpdateDocument = async ({ collectionId, documentId, data, read, wr
     
     /** Body Params */
     if (typeof data !== 'undefined') {
-        payload['data'] = data;
+        payload['data'] = JSON.parse(data);
     }
 
     if (typeof read !== 'undefined') {
@@ -962,7 +965,7 @@ database
     .description(`Create a new Collection.`)
     .requiredOption(`--collectionId <collectionId>`, `Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
     .requiredOption(`--name <name>`, `Collection name. Max length: 128 chars.`)
-    .requiredOption(`--permission <permission>`, `Permissions type model to use for reading documents in this collection. You can use collection-level permission set once on the collection using the 'read' and 'write' params, or you can set document-level permission where each document read and write params will decide who has access to read and write to each document individually. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.`)
+    .requiredOption(`--permission <permission>`, `Specifies the permissions model used in this collection, which accepts either 'collection' or 'document'. For 'collection' level permission, the permissions specified in read and write params are applied to all documents in the collection. For 'document' level permissions, read and write permissions are specified in each document. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.`)
     .requiredOption(`--read <read...>`, `An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.`)
     .requiredOption(`--write <write...>`, `An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.`)
     .action(actionRunner(databaseCreateCollection))
@@ -1021,7 +1024,7 @@ database
     .description(``)
     .requiredOption(`--collectionId <collectionId>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection).`)
     .requiredOption(`--key <key>`, `Attribute Key.`)
-    .requiredOption(`--elements <elements...>`, `Array of elements in enumerated type. Uses length of longest element to determine size.`)
+    .requiredOption(`--elements <elements...>`, `Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 1024 characters long.`)
     .requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
     .option(`--xdefault <xdefault>`, `Default value for attribute when not provided. Cannot be set when attribute is required.`)
     .option(`--array <array>`, `Is attribute an array?`, parseBool)
@@ -1100,13 +1103,13 @@ database
     .command(`listDocuments`)
     .description(`Get a list of all the user documents. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project's documents. [Learn more about different API modes](/docs/admin).`)
     .requiredOption(`--collectionId <collectionId>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection).`)
-    .option(`--queries <queries...>`, `Array of query strings.`)
+    .option(`--queries <queries...>`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/database#querying-documents). Maximum of 100 queries are allowed, each 128 characters long.`)
     .option(`--limit <limit>`, `Maximum number of documents to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request.`, parseInteger)
     .option(`--offset <offset>`, `Offset value. The default value is 0. Use this value to manage pagination. [learn more about pagination](https://appwrite.io/docs/pagination)`, parseInteger)
     .option(`--cursor <cursor>`, `ID of the document used as the starting point for the query, excluding the document itself. Should be used for efficient pagination when working with large sets of data. [learn more about pagination](https://appwrite.io/docs/pagination)`)
     .option(`--cursorDirection <cursorDirection>`, `Direction of the cursor.`)
-    .option(`--orderAttributes <orderAttributes...>`, `Array of attributes used to sort results.`)
-    .option(`--orderTypes <orderTypes...>`, `Array of order directions for sorting attribtues. Possible values are DESC for descending order, or ASC for ascending order.`)
+    .option(`--orderAttributes <orderAttributes...>`, `Array of attributes used to sort results. Maximum of 100 order attributes are allowed, each 128 characters long.`)
+    .option(`--orderTypes <orderTypes...>`, `Array of order directions for sorting attribtues. Possible values are DESC for descending order, or ASC for ascending order. Maximum of 100 order types are allowed.`)
     .action(actionRunner(databaseListDocuments))
 
 database
@@ -1131,14 +1134,14 @@ database
     .description(`Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.`)
     .requiredOption(`--collectionId <collectionId>`, `Collection ID.`)
     .requiredOption(`--documentId <documentId>`, `Document ID.`)
-    .requiredOption(`--data <data>`, `Document data as JSON object.`)
+    .requiredOption(`--data <data>`, `Document data as JSON object. Include only attribute and value pairs to be updated.`)
     .option(`--read <read...>`, `An array of strings with read permissions. By default inherits the existing read permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.`)
     .option(`--write <write...>`, `An array of strings with write permissions. By default inherits the existing write permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.`)
     .action(actionRunner(databaseUpdateDocument))
 
 database
     .command(`deleteDocument`)
-    .description(`Delete a document by its unique ID. This endpoint deletes only the parent documents, its attributes and relations to other documents. Child documents **will not** be deleted.`)
+    .description(`Delete a document by its unique ID.`)
     .requiredOption(`--collectionId <collectionId>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection).`)
     .requiredOption(`--documentId <documentId>`, `Document ID.`)
     .action(actionRunner(databaseDeleteDocument))
@@ -1164,8 +1167,8 @@ database
     .requiredOption(`--collectionId <collectionId>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection).`)
     .requiredOption(`--key <key>`, `Index Key.`)
     .requiredOption(`--type <type>`, `Index type.`)
-    .requiredOption(`--attributes <attributes...>`, `Array of attributes to index.`)
-    .option(`--orders <orders...>`, `Array of index orders.`)
+    .requiredOption(`--attributes <attributes...>`, `Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.`)
+    .option(`--orders <orders...>`, `Array of index orders. Maximum of 100 orders are allowed.`)
     .action(actionRunner(databaseCreateIndex))
 
 database
@@ -1235,4 +1238,4 @@ module.exports = {
     databaseListCollectionLogs,
     databaseGetUsage,
     databaseGetCollectionUsage
-};
+};

package/lib/commands/deploy.js

@@ -1,4 +1,5 @@
 const inquirer = require("inquirer");
+const JSONbig = require("json-bigint")({ storeAsString: false });
 const { Command } = require("commander");
 const { localConfig } = require("../config");
 const { questionsDeployFunctions, questionsGetEntrypoint, questionsDeployCollections } = require("../questions");
@@ -167,7 +168,7 @@ const deployFunction = async () => {
                 functionId: func['$id'],
                 name: func.name,
                 execute: func.execute,
-                vars: func.vars,
+                vars: JSON.stringify(response.vars),
                 events: func.events,
                 schedule: func.schedule,
                 timeout: func.timeout,
@@ -181,7 +182,7 @@ const deployFunction = async () => {
                     name: func.name,
                     runtime: func.runtime,
                     execute: func.execute,
-                    vars: func.vars,
+                    vars: JSON.stringify(func.vars),
                     events: func.events,
                     schedule: func.schedule,
                     timeout: func.timeout,
@@ -319,7 +320,7 @@ const createAttribute = async (collectionId, attribute) => {
 const deployCollection = async () => {
     let response = {};
     let answers = await inquirer.prompt(questionsDeployCollections[0])
-    let collections = answers.collections
+    let collections = answers.collections.map((collection) => JSONbig.parse(collection));
 
     for (let collection of collections) {
         log(`Deploying collection ${collection.name} ( ${collection['$id']} )`)

package/lib/commands/functions.js

@@ -1,7 +1,10 @@
 const fs = require('fs');
+const pathLib = require('path');
+const tar = require("tar");
+const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
+const { getAllFiles } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -84,7 +87,7 @@ const functionsCreate = async ({ functionId, name, execute, runtime, vars, event
     }
 
     if (typeof vars !== 'undefined') {
-        payload['vars'] = vars;
+        payload['vars'] = JSON.parse(vars);
     }
 
     if (typeof events !== 'undefined') {
@@ -169,7 +172,7 @@ const functionsUpdate = async ({ functionId, name, execute, vars, events, schedu
     }
 
     if (typeof vars !== 'undefined') {
-        payload['vars'] = vars;
+        payload['vars'] = JSON.parse(vars);
     }
 
     if (typeof events !== 'undefined') {
@@ -261,7 +264,7 @@ const functionsListDeployments = async ({ functionId, search, limit, offset, cur
 const functionsCreateDeployment = async ({ functionId, entrypoint, code, activate, parseOutput = true, sdk = undefined, onProgress = () => {}}) => {
     /* @param {string} functionId */
     /* @param {string} entrypoint */
-    /* @param {File} code */
+    /* @param {string} code */
     /* @param {boolean} activate */
 
     let client = !sdk ? await sdkForProject() : sdk;
@@ -276,10 +279,32 @@ const functionsCreateDeployment = async ({ functionId, entrypoint, code, activat
     let folderPath = fs.realpathSync(code);
     if (!fs.lstatSync(folderPath).isDirectory())
         throw new Error('The path is not a directory.');
-    childProcess.execSync(`tar --cd '${folderPath}' -zcvf code.tar.gz .`, { stdio: 'pipe' });
+    
+    const ignorer = ignore();
+
+    const func = localConfig.getFunction(functionId);
+
+    if(func.ignore) {
+        ignorer.add(func.ignore);
+        log('Ignoring files using configuration from appwrite.json');
+    } else if(fs.existsSync(pathLib.join(code, '.gitignore'))) {
+        ignorer.add(fs.readFileSync(pathLib.join(code, '.gitignore')).toString());
+        log('Ignoring files in .gitignore');
+    }
+    
+    const files = getAllFiles(code).map((file) => pathLib.relative(code, file)).filter((file) => !ignorer.ignores(file));
+
+    await tar
+        .create({
+            gzip: true,
+            sync: true,
+            cwd: folderPath,
+            file: 'code.tar.gz'
+        }, files);
     let archivePath = fs.realpathSync('code.tar.gz')
     if (typeof archivePath !== 'undefined') {
         payload['code'] = archivePath;
+        code = archivePath;
     }
 
     if (typeof activate !== 'undefined') {
@@ -294,40 +319,53 @@ const functionsCreateDeployment = async ({ functionId, entrypoint, code, activat
 
         response = await client.call('post', path, {
             'content-type': 'multipart/form-data',
-        }, payload);
+        }, payload).catch(err => {
+            fs.unlinkSync(archivePath);
+            throw err
+        });
     } else {
         const streamFilePath = payload['code'];
         let id = undefined;
 
+        let counter = 0;
         const totalCounters = Math.ceil(size / libClient.CHUNK_SIZE);
 
-        for (let counter = 0; counter < totalCounters; counter++) {
-                const start = (counter * libClient.CHUNK_SIZE);
-                const end = Math.min((((counter * libClient.CHUNK_SIZE) + libClient.CHUNK_SIZE) - 1), size);
-                const headers = {
-                        'content-type': 'multipart/form-data',
-                        'content-range': 'bytes ' + start + '-' + end + '/' + size
-                };
-
-                if (id) {
-                        headers['x-appwrite-id'] = id;
-                }
-
-                const stream = fs.createReadStream(streamFilePath, {
-                        start,
-                        end
-                });
-                payload['code'] = stream;
+        const headers = {
+            'content-type': 'multipart/form-data',
+        };
 
-                response = await client.call('post', path, headers, payload);
 
-                if (!id) {
-                        id = response['$id'];
-                }
+        for (counter; counter < totalCounters; counter++) {
+            const start = (counter * libClient.CHUNK_SIZE);
+            const end = Math.min((((counter * libClient.CHUNK_SIZE) + libClient.CHUNK_SIZE) - 1), size);
 
-                if (onProgress !== null) {
-                        onProgress(Math.min((counter+1) * libClient.CHUNK_SIZE, size) / size * 100);
-                }
+            headers['content-range'] = 'bytes ' + start + '-' + end + '/' + size;
+
+            if (id) {
+                headers['x-appwrite-id'] = id;
+            }
+
+            const stream = fs.createReadStream(streamFilePath, {
+                start,
+                end
+            });
+            payload['code'] = stream;
+
+            response = await client.call('post', path, headers, payload);
+
+            if (!id) {
+                id = response['$id'];
+            }
+
+            if (onProgress !== null) {
+                onProgress({
+                    $id: response['$id'],
+                    progress: Math.min((counter+1) * libClient.CHUNK_SIZE, size) / size * 100,
+                    sizeUploaded: end+1,
+                    chunksTotal: response['chunksTotal'],
+                    chunksUploaded: response['chunksUploaded']
+                });
+            }
         }
     }
 
@@ -547,17 +585,17 @@ functions
     .description(`Create a new function. You can pass a list of [permissions](/docs/permissions) to allow different project users or team with access to execute the function using the client API.`)
     .requiredOption(`--functionId <functionId>`, `Function ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
     .requiredOption(`--name <name>`, `Function name. Max length: 128 chars.`)
-    .requiredOption(`--execute <execute...>`, `An array of strings with execution permissions. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.`)
+    .requiredOption(`--execute <execute...>`, `An array of strings with execution permissions. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions. Maximum of 100 scopes are allowed, each 64 characters long.`)
     .requiredOption(`--runtime <runtime>`, `Execution runtime.`)
     .option(`--vars <vars>`, `Key-value JSON object that will be passed to the function as environment variables.`)
-    .option(`--events <events...>`, `Events list.`)
+    .option(`--events <events...>`, `Events list. Maximum of 100 events are allowed.`)
     .option(`--schedule <schedule>`, `Schedule CRON syntax.`)
     .option(`--timeout <timeout>`, `Function maximum execution time in seconds.`, parseInteger)
     .action(actionRunner(functionsCreate))
 
 functions
     .command(`listRuntimes`)
-    .description(`Get a list of all runtimes that are currently active in your project.`)
+    .description(`Get a list of all runtimes that are currently active on your instance.`)
     .action(actionRunner(functionsListRuntimes))
 
 functions
@@ -571,9 +609,9 @@ functions
     .description(`Update function by its unique ID.`)
     .requiredOption(`--functionId <functionId>`, `Function ID.`)
     .requiredOption(`--name <name>`, `Function name. Max length: 128 chars.`)
-    .requiredOption(`--execute <execute...>`, `An array of strings with execution permissions. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.`)
+    .requiredOption(`--execute <execute...>`, `An array of strings with execution permissions. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions. Maximum of 100 scopes are allowed, each 64 characters long.`)
     .option(`--vars <vars>`, `Key-value JSON object that will be passed to the function as environment variables.`)
-    .option(`--events <events...>`, `Events list.`)
+    .option(`--events <events...>`, `Events list. Maximum of 100 events are allowed.`)
     .option(`--schedule <schedule>`, `Schedule CRON syntax.`)
     .option(`--timeout <timeout>`, `Maximum execution time in seconds.`, parseInteger)
     .action(actionRunner(functionsUpdate))
@@ -686,4 +724,4 @@ module.exports = {
     functionsCreateExecution,
     functionsGetExecution,
     functionsGetUsage
-};
+};

package/lib/commands/generic.js

@@ -1,5 +1,6 @@
 const inquirer = require("inquirer");
 const { Command } = require("commander");
+const Client = require("../client");
 const { sdkForConsole } = require("../sdks");
 const { globalConfig, localConfig } = require("../config");
 const { actionRunner, success, parseBool, commandDescriptions, log, parse } = require("../parser");
@@ -65,13 +66,19 @@ const client = new Command("client")
         if (endpoint !== undefined) {
             try {
                 let url = new URL(endpoint);
-                if (url.protocol === "http:" || url.protocol === "https:") {
-                    globalConfig.setEndpoint(endpoint);
-                } else {
+                if (url.protocol !== "http:" && url.protocol !== "https:") {
                     throw new Error();
                 }
+                
+                let client = new Client().setEndpoint(endpoint);
+                let response = await client.call('GET', '/health/version');
+                if(!response.version) {
+                    throw new Error();
+                }
+                
+                globalConfig.setEndpoint(endpoint);
             } catch (_) {
-                throw new Error("Invalid endpoint");
+                throw new Error("Invalid endpoint or your Appwrite server is not running as expected.");
             }
         }
 

package/lib/commands/health.js

@@ -1,7 +1,10 @@
 const fs = require('fs');
+const pathLib = require('path');
+const tar = require("tar");
+const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
+const { getAllFiles } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -128,23 +131,6 @@ const healthGetQueueLogs = async ({ parseOutput = true, sdk = undefined}) => {
     return response;
 }
 
-const healthGetQueueUsage = async ({ parseOutput = true, sdk = undefined}) => {
-
-    let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/health/queue/usage';
-    let payload = {};
-    let response = undefined;
-    response = await client.call('get', path, {
-        'content-type': 'application/json',
-    }, payload);
-    
-    if (parseOutput) {
-        parse(response)
-        success()
-    }
-    return response;
-}
-
 const healthGetQueueWebhooks = async ({ parseOutput = true, sdk = undefined}) => {
 
     let client = !sdk ? await sdkForProject() : sdk;
@@ -232,11 +218,6 @@ health
     .description(`Get the number of logs that are waiting to be processed in the Appwrite internal queue server.`)
     .action(actionRunner(healthGetQueueLogs))
 
-health
-    .command(`getQueueUsage`)
-    .description(`Get the number of usage stats that are waiting to be processed in the Appwrite internal queue server.`)
-    .action(actionRunner(healthGetQueueUsage))
-
 health
     .command(`getQueueWebhooks`)
     .description(`Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.`)
@@ -262,8 +243,7 @@ module.exports = {
     healthGetQueueCertificates,
     healthGetQueueFunctions,
     healthGetQueueLogs,
-    healthGetQueueUsage,
     healthGetQueueWebhooks,
     healthGetStorageLocal,
     healthGetTime
-};
+};

package/lib/commands/init.js

@@ -99,8 +99,8 @@ const initFunction = async () => {
     runtime: response.runtime,
     path: `functions/${answers.name}`,
     entrypoint: answers.runtime.entrypoint || '',
+    ignore: answers.runtime.ignore || null,
     execute: response.execute,
-    vars: response.vars,
     events: response.events,
     schedule: response.schedule,
     timeout: response.timeout,

package/lib/commands/locale.js

@@ -1,7 +1,10 @@
 const fs = require('fs');
+const pathLib = require('path');
+const tar = require("tar");
+const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
+const { getAllFiles } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -174,4 +177,4 @@ module.exports = {
     localeGetCountriesPhones,
     localeGetCurrencies,
     localeGetLanguages
-};
+};

package/lib/commands/projects.js

@@ -1,7 +1,10 @@
 const fs = require('fs');
+const pathLib = require('path');
+const tar = require("tar");
+const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
+const { getAllFiles } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -1018,7 +1021,7 @@ projects
     .description(``)
     .requiredOption(`--projectId <projectId>`, `Project unique ID.`)
     .requiredOption(`--name <name>`, `Key name. Max length: 128 chars.`)
-    .requiredOption(`--scopes <scopes...>`, `Key scopes list.`)
+    .requiredOption(`--scopes <scopes...>`, `Key scopes list. Maximum of 100 scopes are allowed.`)
     .action(actionRunner(projectsCreateKey))
 
 projects
@@ -1034,7 +1037,7 @@ projects
     .requiredOption(`--projectId <projectId>`, `Project unique ID.`)
     .requiredOption(`--keyId <keyId>`, `Key unique ID.`)
     .requiredOption(`--name <name>`, `Key name. Max length: 128 chars.`)
-    .requiredOption(`--scopes <scopes...>`, `Key scopes list`)
+    .requiredOption(`--scopes <scopes...>`, `Key scopes list. Maximum of 100 events are allowed.`)
     .action(actionRunner(projectsUpdateKey))
 
 projects
@@ -1121,7 +1124,7 @@ projects
     .description(``)
     .requiredOption(`--projectId <projectId>`, `Project unique ID.`)
     .requiredOption(`--name <name>`, `Webhook name. Max length: 128 chars.`)
-    .requiredOption(`--events <events...>`, `Events list.`)
+    .requiredOption(`--events <events...>`, `Events list. Maximum of 100 events are allowed.`)
     .requiredOption(`--url <url>`, `Webhook URL.`)
     .requiredOption(`--security <security>`, `Certificate verification, false for disabled or true for enabled.`, parseBool)
     .option(`--httpUser <httpUser>`, `Webhook HTTP user. Max length: 256 chars.`)
@@ -1141,7 +1144,7 @@ projects
     .requiredOption(`--projectId <projectId>`, `Project unique ID.`)
     .requiredOption(`--webhookId <webhookId>`, `Webhook unique ID.`)
     .requiredOption(`--name <name>`, `Webhook name. Max length: 128 chars.`)
-    .requiredOption(`--events <events...>`, `Events list.`)
+    .requiredOption(`--events <events...>`, `Events list. Maximum of 100 events are allowed.`)
     .requiredOption(`--url <url>`, `Webhook URL.`)
     .requiredOption(`--security <security>`, `Certificate verification, false for disabled or true for enabled.`, parseBool)
     .option(`--httpUser <httpUser>`, `Webhook HTTP user. Max length: 256 chars.`)
@@ -1188,4 +1191,4 @@ module.exports = {
     projectsGetWebhook,
     projectsUpdateWebhook,
     projectsDeleteWebhook
-};
+};