appwrite-cli 1.1.1 → 1.2.1

package/Formula/appwrite.rb

@@ -4,7 +4,7 @@ class Appwrite < Formula
   desc "CLI is a Node based command-line tool for Appwrite API"
   homepage "https://appwrite.io"
   license "BSD-3-Clause"
-  head "https://github.com/appwrite/sdk-for-cli.git", branch: "main"
+  head "https://github.com/appwrite/sdk-for-cli.git", branch: "master"
 
   depends_on "node"
 

package/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2022 Appwrite (https://appwrite.io) and individual contributors.
+Copyright (c) 2023 Appwrite (https://appwrite.io) and individual contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
@@ -7,6 +7,6 @@ Redistribution and use in source and binary forms, with or without modification,
 
     2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 
-    3. Neither the name Appwrite nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+    3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,12 +1,12 @@
 # Appwrite Command Line SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-cli.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.0.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.2.1-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
-**This SDK is compatible with Appwrite server version 1.0.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-cli/releases).**
+**This SDK is compatible with Appwrite server version 1.2.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-cli/releases).**
 
 Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Command Line SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
 
@@ -29,7 +29,7 @@ Once the installation is complete, you can verify the install using
 
 ```sh
 $ appwrite -v
-1.1.1
+1.2.1
 ```
 
 ### Install using prebuilt binaries
@@ -58,7 +58,7 @@ $ iwr -useb https://appwrite.io/cli/install.ps1 | iex
 Once the installation completes, you can verify your install using
 ```
 $ appwrite -v
-1.1.1
+1.2.1
 ```
 
 ## Getting Started 

package/docs/examples/account/create-phone-session.md

@@ -1,3 +1,3 @@
 appwrite account createPhoneSession \
         --userId [USER_ID] \
-        --phone ''
+        --phone +12065550100

package/docs/examples/account/get-logs.md

@@ -0,0 +1,2 @@
+appwrite account getLogs \
+

package/docs/examples/account/get-sessions.md

@@ -0,0 +1 @@
+appwrite account getSessions

package/docs/examples/account/update-phone.md

@@ -1,3 +1,3 @@
 appwrite account updatePhone \
-        --phone '' \
+        --phone +12065550100 \
         --password password

package/docs/examples/functions/create-build.md

@@ -0,0 +1,4 @@
+appwrite functions createBuild \
+        --functionId [FUNCTION_ID] \
+        --deploymentId [DEPLOYMENT_ID] \
+        --buildId [BUILD_ID]

package/docs/examples/graphql/mutation.md

@@ -0,0 +1,2 @@
+appwrite graphql mutation \
+        --query '{ "key": "value" }'

package/docs/examples/graphql/query.md

@@ -0,0 +1,2 @@
+appwrite graphql query \
+        --query '{ "key": "value" }'

package/docs/examples/locale/get-continents.md

@@ -0,0 +1 @@
+appwrite locale getContinents

package/docs/examples/locale/get-countries-e-u.md

@@ -0,0 +1 @@
+appwrite locale getCountriesEU

package/docs/examples/locale/get-countries-phones.md

@@ -0,0 +1 @@
+appwrite locale getCountriesPhones

package/docs/examples/locale/get-countries.md

@@ -0,0 +1 @@
+appwrite locale getCountries

package/docs/examples/locale/get-currencies.md

@@ -0,0 +1 @@
+appwrite locale getCurrencies

package/docs/examples/locale/get-languages.md

@@ -0,0 +1 @@
+appwrite locale getLanguages

package/docs/examples/projects/create.md

@@ -11,3 +11,4 @@ appwrite projects create \
 
 
 
+

package/docs/examples/projects/update-auth-duration.md

@@ -0,0 +1,3 @@
+appwrite projects updateAuthDuration \
+        --projectId [PROJECT_ID] \
+        --duration 0

package/docs/examples/projects/update-auth-sessions-limit.md

@@ -0,0 +1,3 @@
+appwrite projects updateAuthSessionsLimit \
+        --projectId [PROJECT_ID] \
+        --limit 1

package/docs/examples/projects/update-o-auth2.md

@@ -3,3 +3,4 @@ appwrite projects updateOAuth2 \
         --provider amazon \
 
 
+

package/docs/examples/teams/get-memberships.md

@@ -0,0 +1,4 @@
+appwrite teams getMemberships \
+        --teamId [TEAM_ID] \
+
+

package/docs/examples/users/get-logs.md

@@ -0,0 +1,3 @@
+appwrite users getLogs \
+        --userId [USER_ID] \
+

package/docs/examples/users/get-memberships.md

@@ -0,0 +1,2 @@
+appwrite users getMemberships \
+        --userId [USER_ID]

package/docs/examples/users/get-sessions.md

@@ -0,0 +1,2 @@
+appwrite users getSessions \
+        --userId [USER_ID]

package/docs/examples/users/update-phone.md

@@ -1,3 +1,3 @@
 appwrite users updatePhone \
         --userId [USER_ID] \
-        --number ''
+        --number +12065550100

package/index.js

@@ -1,4 +1,10 @@
 #! /usr/bin/env node
+
+/** Required to set max width of the help commands */
+const oldWidth = process.stdout.columns
+process.stdout.columns = 100
+/** ---------------------------------------------- */
+
 const program = require("commander");
 const chalk = require("chalk");
 const { version } = require("./package.json");
@@ -11,6 +17,7 @@ const { account } = require("./lib/commands/account");
 const { avatars } = require("./lib/commands/avatars");
 const { databases } = require("./lib/commands/databases");
 const { functions } = require("./lib/commands/functions");
+const { graphql } = require("./lib/commands/graphql");
 const { health } = require("./lib/commands/health");
 const { locale } = require("./lib/commands/locale");
 const { projects } = require("./lib/commands/projects");
@@ -20,6 +27,10 @@ const { users } = require("./lib/commands/users");
 
 program
   .description(commandDescriptions['main'])
+  .configureHelp({
+    helpWidth: process.stdout.columns || 80,
+    sortSubcommands: true
+  })
   .version(version, "-v, --version")
   .option("--verbose", "Show complete error log")
   .option("--json", "Output in JSON format")
@@ -38,6 +49,7 @@ program
   .addCommand(avatars)
   .addCommand(databases)
   .addCommand(functions)
+  .addCommand(graphql)
   .addCommand(health)
   .addCommand(locale)
   .addCommand(projects)
@@ -46,4 +58,5 @@ program
   .addCommand(users)
   .addCommand(client)
   .parse(process.argv);
-  
+  
+process.stdout.columns = oldWidth;

package/install.ps1

@@ -13,8 +13,8 @@
 # You can use "View source" of this page to see the full script.
 
 # REPO
-$GITHUB_x64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/1.1.1/appwrite-cli-win-x64.exe"
-$GITHUB_arm64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/1.1.1/appwrite-cli-win-arm64.exe"
+$GITHUB_x64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/1.2.1/appwrite-cli-win-x64.exe"
+$GITHUB_arm64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/1.2.1/appwrite-cli-win-arm64.exe"
 
 $APPWRITE_BINARY_NAME = "appwrite.exe"
 

package/install.sh

@@ -97,7 +97,7 @@ printSuccess() {
 downloadBinary() {
     echo "[2/4] Downloading executable for $OS ($ARCH) ..."
 
-    GITHUB_LATEST_VERSION="1.1.1"
+    GITHUB_LATEST_VERSION="1.2.1"
     GITHUB_FILE="appwrite-cli-${OS}-${ARCH}"
     GITHUB_URL="https://github.com/$GITHUB_REPOSITORY_NAME/releases/download/$GITHUB_LATEST_VERSION/$GITHUB_FILE"
 

package/lib/client.js

@@ -15,8 +15,8 @@ class Client {
       'x-sdk-name': 'Command Line',
       'x-sdk-platform': 'console',
       'x-sdk-language': 'cli',
-      'x-sdk-version': '1.1.1',
-      'user-agent' : `AppwriteCLI/1.1.1 (${os.type()} ${os.version()}; ${os.arch()})`,
+      'x-sdk-version': '1.2.1',
+      'user-agent' : `AppwriteCLI/1.2.1 (${os.type()} ${os.version()}; ${os.arch()})`,
       'X-Appwrite-Response-Format' : '1.0.0',
     };
   }

package/lib/commands/account.js

@@ -10,7 +10,9 @@ const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
 const { localConfig, globalConfig } = require("../config");
 
-const account = new Command("account").description(commandDescriptions['account'])
+const account = new Command("account").description(commandDescriptions['account']).configureHelp({
+    helpWidth: process.stdout.columns || 80
+  })
 
 const accountGet = async ({ parseOutput = true, sdk = undefined}) => {
 
@@ -740,7 +742,7 @@ account
 account
     .command(`create`)
     .description(`Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [/account/verfication](/docs/client/account#accountCreateVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](/docs/client/account#accountCreateSession).`)
-    .requiredOption(`--userId <userId>`, `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(`--userId <userId>`, `Unique Id. Choose a custom ID or generate a random ID with 'ID.unique()'. 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(`--email <email>`, `User email.`)
     .requiredOption(`--password <password>`, `User password. Must be at least 8 chars.`)
     .option(`--name <name>`, `User name. Max length: 128 chars.`)
@@ -828,15 +830,15 @@ account
 
 account
     .command(`createEmailSession`)
-    .description(`Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.`)
+    .description(`Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.  A user is limited to 10 active sessions at a time by default. [Learn more about session limits](/docs/authentication#limits).`)
     .requiredOption(`--email <email>`, `User email.`)
     .requiredOption(`--password <password>`, `User password. Must be at least 8 chars.`)
     .action(actionRunner(accountCreateEmailSession))
 
 account
     .command(`createMagicURLSession`)
-    .description(`Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [PUT /account/sessions/magic-url](/docs/client/account#accountUpdateMagicURLSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.`)
-    .requiredOption(`--userId <userId>`, `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.`)
+    .description(`Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [PUT /account/sessions/magic-url](/docs/client/account#accountUpdateMagicURLSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.  A user is limited to 10 active sessions at a time by default. [Learn more about session limits](/docs/authentication#limits).`)
+    .requiredOption(`--userId <userId>`, `Unique Id. Choose a custom ID or generate a random ID with 'ID.unique()'. 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(`--email <email>`, `User email.`)
     .option(`--url <url>`, `URL to redirect the user back to your app from the magic URL login. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.`)
     .action(actionRunner(accountCreateMagicURLSession))
@@ -850,7 +852,7 @@ account
 
 account
     .command(`createOAuth2Session`)
-    .description(`Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.  If there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.. `)
+    .description(`Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.  If there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.  A user is limited to 10 active sessions at a time by default. [Learn more about session limits](/docs/authentication#limits). `)
     .requiredOption(`--provider <provider>`, `OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoom.`)
     .option(`--success <success>`, `URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.`)
     .option(`--failure <failure>`, `URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.`)
@@ -859,8 +861,8 @@ account
 
 account
     .command(`createPhoneSession`)
-    .description(`Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [PUT /account/sessions/phone](/docs/client/account#accountUpdatePhoneSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.`)
-    .requiredOption(`--userId <userId>`, `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.`)
+    .description(`Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [PUT /account/sessions/phone](/docs/client/account#accountUpdatePhoneSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.  A user is limited to 10 active sessions at a time by default. [Learn more about session limits](/docs/authentication#limits).`)
+    .requiredOption(`--userId <userId>`, `Unique Id. Choose a custom ID or generate a random ID with 'ID.unique()'. 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(`--phone <phone>`, `Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.`)
     .action(actionRunner(accountCreatePhoneSession))
 

package/lib/commands/avatars.js

@@ -10,7 +10,9 @@ const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
 const { localConfig, globalConfig } = require("../config");
 
-const avatars = new Command("avatars").description(commandDescriptions['avatars'])
+const avatars = new Command("avatars").description(commandDescriptions['avatars']).configureHelp({
+    helpWidth: process.stdout.columns || 80
+  })
 
 const avatarsGetBrowser = async ({ code, width, height, quality, parseOutput = true, sdk = undefined, destination}) => {
     /* @param {string} code */

package/lib/commands/databases.js

@@ -10,7 +10,9 @@ const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
 const { localConfig, globalConfig } = require("../config");
 
-const databases = new Command("databases").description(commandDescriptions['databases'])
+const databases = new Command("databases").description(commandDescriptions['databases']).configureHelp({
+    helpWidth: process.stdout.columns || 80
+  })
 
 const databasesList = async ({ queries, search, parseOutput = true, sdk = undefined}) => {
     /* @param {string[]} queries */
@@ -1125,7 +1127,7 @@ databases
 databases
     .command(`create`)
     .description(`Create a new Database. `)
-    .requiredOption(`--databaseId <databaseId>`, `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(`--databaseId <databaseId>`, `Unique Id. Choose a custom ID or generate a random ID with 'ID.unique()'. 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.`)
     .action(actionRunner(databasesCreate))
 
@@ -1145,7 +1147,7 @@ databases
     .command(`update`)
     .description(`Update a database by its unique ID.`)
     .requiredOption(`--databaseId <databaseId>`, `Database ID.`)
-    .requiredOption(`--name <name>`, `Collection name. Max length: 128 chars.`)
+    .requiredOption(`--name <name>`, `Database name. Max length: 128 chars.`)
     .action(actionRunner(databasesUpdate))
 
 databases
@@ -1166,9 +1168,9 @@ databases
     .command(`createCollection`)
     .description(`Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](/docs/server/databases#databasesCreateCollection) API or directly from your database console.`)
     .requiredOption(`--databaseId <databaseId>`, `Database ID.`)
-    .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(`--collectionId <collectionId>`, `Unique Id. Choose a custom ID or generate a random ID with 'ID.unique()'. 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.`)
-    .option(`--permissions <permissions...>`, `An array of permissions strings. By default no user is granted with any permissions. [Learn more about permissions](/docs/permissions).`)
+    .option(`--permissions <permissions...>`, `An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](/docs/permissions).`)
     .option(`--documentSecurity <documentSecurity>`, `Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](/docs/permissions).`, parseBool)
     .action(actionRunner(databasesCreateCollection))
 
@@ -1185,7 +1187,7 @@ databases
     .requiredOption(`--databaseId <databaseId>`, `Database ID.`)
     .requiredOption(`--collectionId <collectionId>`, `Collection ID.`)
     .requiredOption(`--name <name>`, `Collection name. Max length: 128 chars.`)
-    .option(`--permissions <permissions...>`, `An array of permission strings. By default the current permission are inherited. [Learn more about permissions](/docs/permissions).`)
+    .option(`--permissions <permissions...>`, `An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](/docs/permissions).`)
     .option(`--documentSecurity <documentSecurity>`, `Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](/docs/permissions).`, parseBool)
     .option(`--enabled <enabled>`, `Is collection enabled?`, parseBool)
     .action(actionRunner(databasesUpdateCollection))
@@ -1327,7 +1329,7 @@ databases
 
 databases
     .command(`listDocuments`)
-    .description(`Get a list of all the user's documents in a given collection. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of documents belonging to the provided collectionId. [Learn more about different API modes](/docs/admin).`)
+    .description(`Get a list of all the user's documents in a given collection. You can use the query params to filter your results.`)
     .requiredOption(`--databaseId <databaseId>`, `Database ID.`)
     .requiredOption(`--collectionId <collectionId>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
     .option(`--queries <queries...>`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.`)
@@ -1338,9 +1340,9 @@ databases
     .description(`Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](/docs/server/databases#databasesCreateCollection) API or directly from your database console.`)
     .requiredOption(`--databaseId <databaseId>`, `Database ID.`)
     .requiredOption(`--collectionId <collectionId>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.`)
-    .requiredOption(`--documentId <documentId>`, `Document 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(`--documentId <documentId>`, `Document ID. Choose a custom ID or generate a random ID with 'ID.unique()'. 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(`--data <data>`, `Document data as JSON object.`)
-    .option(`--permissions <permissions...>`, `An array of permissions strings. By default the current user is granted with all permissions. [Learn more about permissions](/docs/permissions).`)
+    .option(`--permissions <permissions...>`, `An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](/docs/permissions).`)
     .action(actionRunner(databasesCreateDocument))
 
 databases
@@ -1358,7 +1360,7 @@ databases
     .requiredOption(`--collectionId <collectionId>`, `Collection ID.`)
     .requiredOption(`--documentId <documentId>`, `Document ID.`)
     .option(`--data <data>`, `Document data as JSON object. Include only attribute and value pairs to be updated.`)
-    .option(`--permissions <permissions...>`, `An array of permissions strings. By default the current permissions are inherited. [Learn more about permissions](/docs/permissions).`)
+    .option(`--permissions <permissions...>`, `An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](/docs/permissions).`)
     .action(actionRunner(databasesUpdateDocument))
 
 databases

package/lib/commands/deploy.js

@@ -2,7 +2,7 @@ const inquirer = require("inquirer");
 const JSONbig = require("json-bigint")({ storeAsString: false });
 const { Command } = require("commander");
 const { localConfig } = require("../config");
-const { questionsDeployFunctions, questionsGetEntrypoint, questionsDeployCollections, questionsConfirmDeployCollections } = require("../questions");
+const { questionsDeployTeams, questionsDeployFunctions, questionsGetEntrypoint, questionsDeployCollections, questionsConfirmDeployCollections } = require("../questions");
 const { actionRunner, success, log, error, commandDescriptions } = require("../parser");
 const { functionsGet, functionsCreate, functionsUpdate, functionsCreateDeployment, functionsUpdateDeployment, functionsListVariables, functionsDeleteVariable, functionsCreateVariable } = require('./functions');
 const {
@@ -25,6 +25,11 @@ const {
     databasesListIndexes,
     databasesDeleteIndex
 } = require("./databases");
+const {
+    teamsGet,
+    teamsUpdate,
+    teamsCreate
+} = require("./teams");
 
 const POOL_DEBOUNCE = 2000; // in milliseconds
 const POOL_MAX_DEBOUNCES = 30;
@@ -138,6 +143,9 @@ const awaitPools = {
 
 const deploy = new Command("deploy")
     .description(commandDescriptions['deploy'])
+    .configureHelp({
+        helpWidth: process.stdout.columns || 80
+    })
     .action(actionRunner(async (_options, command) => {
         command.help()
     }));
@@ -593,6 +601,76 @@ const deployCollection = async ({ all, yes } = {}) => {
     }
 }
 
+const deployTeam = async ({ all, yes } = {}) => {
+    let response = {};
+
+    let teamIds = [];
+    const configTeams = localConfig.getTeams();
+
+    if(all) {
+        if (configTeams.length === 0) {
+            throw new Error("No teams found in the current directory. Run `appwrite init team` to fetch all your teams.");
+        }
+        teamIds.push(...configTeams.map((t) => t.$id));
+    }
+
+    if(teamIds.length === 0) {
+        let answers = await inquirer.prompt(questionsDeployTeams[0])
+        teamIds.push(...answers.teams);
+    }
+
+    let teams = [];
+
+    for(const teamId of teamIds) {
+        const idTeams = configTeams.filter((t) => t.$id === teamId);
+        teams.push(...idTeams);
+    }
+
+    for (let team of teams) {
+        log(`Deploying team ${team.name} ( ${team['$id']} )`)
+
+        try {
+            response = await teamsGet({
+                teamId: team['$id'],
+                parseOutput: false,
+            })
+            log(`Team ${team.name} ( ${team['$id']} ) already exists.`);
+
+            if(!yes) {
+                answers = await inquirer.prompt(questionsDeployTeams[1])
+                if (answers.override !== "YES") {
+                    log(`Received "${answers.override}". Skipping ${team.name} ( ${team['$id']} )`);
+                    continue;
+                }
+            }
+
+            log(`Updating team ...`)
+
+            await teamsUpdate({
+                teamId: team['$id'],
+                name: team.name,
+                parseOutput: false
+            });
+
+            success(`Deployed ${team.name} ( ${team['$id']} )`);
+        } catch (e) {
+            if (e.code == 404) {
+                log(`Team ${team.name} does not exist in the project. Creating ... `);
+
+                response = await teamsCreate({
+                    teamId: team['$id'],
+                    name: team.name,
+                    parseOutput: false
+                })
+
+                success(`Deployed ${team.name} ( ${team['$id']} )`);
+            } else {
+                throw e;
+            }
+        }
+    }
+}
+
 deploy
     .command("function")
     .description("Deploy functions in the current directory.")
@@ -608,6 +686,13 @@ deploy
     .option(`--yes`, `Flag to confirm all warnings`)
     .action(actionRunner(deployCollection));
 
+deploy
+    .command("team")
+    .description("Deploy teams in the current project.")
+    .option(`--all`, `Flag to deploy all teams`)
+    .option(`--yes`, `Flag to confirm all warnings`)
+    .action(actionRunner(deployTeam));
+
 module.exports = {
     deploy
 }

package/lib/commands/functions.js

@@ -10,7 +10,9 @@ const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
 const { localConfig, globalConfig } = require("../config");
 
-const functions = new Command("functions").description(commandDescriptions['functions'])
+const functions = new Command("functions").description(commandDescriptions['functions']).configureHelp({
+    helpWidth: process.stdout.columns || 80
+  })
 
 const functionsList = async ({ queries, search, parseOutput = true, sdk = undefined}) => {
     /* @param {string[]} queries */
@@ -426,7 +428,7 @@ const functionsDeleteDeployment = async ({ functionId, deploymentId, parseOutput
     return response;
 }
 
-const functionsRetryBuild = async ({ functionId, deploymentId, buildId, parseOutput = true, sdk = undefined}) => {
+const functionsCreateBuild = async ({ functionId, deploymentId, buildId, parseOutput = true, sdk = undefined}) => {
     /* @param {string} functionId */
     /* @param {string} deploymentId */
     /* @param {string} buildId */
@@ -675,7 +677,7 @@ functions
 functions
     .command(`create`)
     .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(`--functionId <functionId>`, `Function ID. Choose a custom ID or generate a random ID with 'ID.unique()'. 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 roles. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 64 characters long.`)
     .requiredOption(`--runtime <runtime>`, `Execution runtime.`)
@@ -759,16 +761,16 @@ functions
     .action(actionRunner(functionsDeleteDeployment))
 
 functions
-    .command(`retryBuild`)
+    .command(`createBuild`)
     .description(``)
     .requiredOption(`--functionId <functionId>`, `Function ID.`)
     .requiredOption(`--deploymentId <deploymentId>`, `Deployment ID.`)
     .requiredOption(`--buildId <buildId>`, `Build unique ID.`)
-    .action(actionRunner(functionsRetryBuild))
+    .action(actionRunner(functionsCreateBuild))
 
 functions
     .command(`listExecutions`)
-    .description(`Get a list of all the current user function execution logs. 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 executions. [Learn more about different API modes](/docs/admin).`)
+    .description(`Get a list of all the current user function execution logs. You can use the query params to filter your results.`)
     .requiredOption(`--functionId <functionId>`, `Function ID.`)
     .option(`--queries <queries...>`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, statusCode, duration`)
     .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
@@ -848,7 +850,7 @@ module.exports = {
     functionsGetDeployment,
     functionsUpdateDeployment,
     functionsDeleteDeployment,
-    functionsRetryBuild,
+    functionsCreateBuild,
     functionsListExecutions,
     functionsCreateExecution,
     functionsGetExecution,

package/lib/commands/generic.js

@@ -9,6 +9,9 @@ const { accountCreateEmailSession, accountDeleteSession } = require("./account")
 
 const login = new Command("login")
     .description(commandDescriptions['login'])
+    .configureHelp({
+        helpWidth: process.stdout.columns || 80
+    })
     .action(actionRunner(async () => {
         const answers = await inquirer.prompt(questionsLogin)
 
@@ -26,6 +29,9 @@ const login = new Command("login")
 
 const logout = new Command("logout")
     .description(commandDescriptions['logout'])
+    .configureHelp({
+        helpWidth: process.stdout.columns || 80
+    })
     .action(actionRunner(async () => {
         let client = await sdkForConsole();
 
@@ -41,6 +47,9 @@ const logout = new Command("logout")
 
 const client = new Command("client")
     .description(commandDescriptions['client'])
+    .configureHelp({
+        helpWidth: process.stdout.columns || 80
+    })
     .option("--selfSigned <value>", "Configure the CLI to use a self-signed certificate ( true or false )", parseBool)
     .option("--endpoint <endpoint>", "Set your Appwrite server endpoint")
     .option("--projectId <projectId>", "Set your Appwrite project ID")