appwrite-cli 0.14.0 → 0.17.0

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-0.12.3-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-0.14.0-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 latest. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-cli/releases).**
+**This SDK is compatible with Appwrite server version 0.14.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
-0.14.0
+0.17.0
 ```
 
 ### Install using prebuilt binaries
@@ -58,9 +58,164 @@ $ iwr -useb https://appwrite.io/cli/install.ps1 | iex
 Once the installation completes, you can verify your install using
 ```
 $ appwrite -v
-0.14.0
+0.17.0
 ```
 
+## Getting Started 
+
+Before you can use the CLI, you need to login to your Appwrite account. 
+
+```sh
+$ appwrite login
+
+? Enter your email test@test.com
+? Enter your password ********
+✓ Success 
+```
+This will also prompt you to enter your Appwrite endpoint ( default: http://localhost/v1 ) 
+
+* ### Initialising your project
+Once logged in, the CLI needs to be initialised before you can use it with your Appwrite project. You can do this with the `appwrite init project` command. 
+
+```sh
+$ appwrite init project
+```
+
+The following prompt will guide you through the setup process. The `init` command also creates an `appwrite.json` file representing your Appwrite project.
+
+The `appwrite.json` file does a lot of things. 
+* Provides context to the CLI
+* Keeps track of all your cloud functions
+* Keeps track of all your project's collections
+* Helps you deploy your Appwrite project to production and more..
+
+You can also fetch all the collections in your current project using
+```sh
+appwrite init collection
+```
+
+The CLI also comes with a convenient `--all` flag to perform both these steps at once.
+
+```sh
+appwrite init --all
+```
+
+* ### Creating and deploying cloud functions
+
+The CLI makes it extremely easy to create and deploy Appwrite's cloud functions. Initialise your new function using
+
+```
+$ appwrite init function
+? What would you like to name your function? My Awesome Function
+? What runtime would you like to use? Node.js (node-15.5)
+✓ Success 
+```
+
+This will create a new function `My Awesome Function` in your current Appwrite project and also create a template function for you to get started.
+
+```sh
+$ tree My\ Awesome\ Function 
+
+My Awesome Function
+├── README.md
+├── index.js
+├── package-lock.json
+└── package.json
+
+0 directories, 4 files
+```
+
+You can now deploy this function using 
+
+```sh
+$ appwrite deploy function
+
+? Which functions would you like to deploy? My Awesome Function (61d1a4c81dfcd95bc834)
+ℹ Info Deploying function My Awesome Function ( 61d1a4c81dfcd95bc834 )
+✓ Success Deployed My Awesome Function ( 61d1a4c81dfcd95bc834 )
+```
+
+Your function has now been deployed on your Appwrite server! As soon as the build process is finished, you can start executing the function.
+
+* ### Deploying Collections
+
+Similarly, you can deploy all your collections to your Appwrite server using 
+
+```sh
+appwrite deploy collections
+```
+
+The `deploy` command also comes with a convenient `--all` flag to deploy all your functions and collections at once.
+
+```sh
+appwrite deploy --all
+``` 
+
+> ### Note
+> By default, requests to domains with self signed SSL certificates (or no certificates) are disabled. If you trust the domain, you can bypass the certificate validation using
+```sh
+$ appwrite client --selfSigned true
+```
+
+## Usage 
+
+The Appwrite CLI follows the following general syntax.
+```sh
+$ appwrite [COMMAND] --[OPTIONS]
+```
+
+A few sample commands to get you started 
+
+```sh
+$ appwrite users create --userId "unique()" --email hello@appwrite.io --password very_strong_password
+$ appwrite users list 
+```
+
+To create a document you can use the following command 
+```sh
+$ appwrite database createDocument --collectionId <ID> --documentId 'unique()' --data '{ "Name": "Iron Man" }' --read role:all team:abc
+```
+
+### Some Gotchas
+- `data` must be a valid JSON string where each key and value are enclosed in double quotes `"` like the example above.
+- Some arguments like the `read` and `write` permissions are expected to be arrays. In the Appwrite CLI, array values are passed in using space as a separator like in the example above.
+
+
+To get information about the different services available, you can use 
+```sh
+$ appwrite -h
+```
+
+To get information about a particular service and the commands available in a service you can use 
+```sh
+$ appwrite users // or
+$ appwrite users --help // or
+$ appwrite users help // or
+$ appwrite accounts
+```
+
+To get information about a particular command and the parameters it accepts, you can use
+
+```sh
+$ appwrite users list --help
+$ appwrite account get --help 
+```
+
+At any point, you can view or reset the CLI configuration using the `client` service.
+
+```
+$ appwrite client --debug
+// This will display your endpoint, projectID, API key and so on.
+$ appwrite client --reset
+```
+
+## CI mode
+
+The Appwrite CLI can also work in a CI environment. The initialisation of the CLI works a bit differently in CI. In CI, you set your `endpoint`, `projectId` and `API Key` using 
+
+```sh
+appwrite client --endpoint http://localhost/v1 --projectId <PROJECT_ID> --key <API KEY>
+```
 
 ## Contribution
 

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

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

package/docs/examples/teams/list-logs.md

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

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

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

package/install.ps1

@@ -0,0 +1,98 @@
+## <script src="/dist/scripts/cli-bash.js"></script>
+## <link href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/themes/prism-okaidia.min.css" rel="stylesheet" />
+## <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/components/prism-core.min.js" data-manual></script>
+## <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/components/prism-powershell.min.js"></script>
+## <style>body {color: #272822; background-color: #272822; font-size: 0.8em;} </style>
+# Love open-source, dev-tooling and passionate about code as much as we do?
+# ---
+# We're always looking for awesome hackers like you to join our 100% remote team!
+# Check and see if you find any relevant position @ https://appwrite.io/company/careers 👩‍💻 😎
+# (and let us know you found this message...)
+
+# This script contains hidden JS code to allow better readability and syntax highlighting
+# 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/0.17.0/appwrite-cli-win-x64.exe"
+$GITHUB_arm64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/0.17.0/appwrite-cli-win-arm64.exe"
+
+$APPWRITE_BINARY_NAME = "appwrite.exe"
+
+# Appwrite download directory
+$APPWRITE_DOWNLOAD_DIR = Join-Path -Path $env:TEMP -ChildPath $APPWRITE_BINARY_NAME
+
+# Appwrite CLI location
+$APPWRITE_INSTALL_DIR = Join-Path -Path $env:LOCALAPPDATA -ChildPath "Appwrite"
+$APPWRITE_INSTALL_PATH = Join-Path -Path "$APPWRITE_INSTALL_DIR" -ChildPath "$APPWRITE_BINARY_NAME"
+
+$USER_PATH_ENV_VAR = [Environment]::GetEnvironmentVariable("PATH", "User")
+
+function Greeting {
+    Write-Host @"
+
+     _                            _ _           ___   __   _____ 
+    /_\  _ __  _ ____      ___ __(_) |_ ___    / __\ / /   \_   \
+   //_\\| '_ \| '_ \ \ /\ / / '__| | __/ _ \  / /   / /     / /\/
+  /  _  \ |_) | |_) \ V  V /| |  | | ||  __/ / /___/ /___/\/ /_  
+  \_/ \_/ .__/| .__/ \_/\_/ |_|  |_|\__\___| \____/\____/\____/  
+        |_|   |_|                                                
+
+"@ -ForegroundColor red
+    Write-Host "Welcome to the Appwrite CLI install shield."  
+}
+
+
+function CheckSystemInfo {
+    Write-Host "[1/4] Getting System Info ..."
+    if ((Get-ExecutionPolicy) -gt 'RemoteSigned' -or (Get-ExecutionPolicy) -eq 'ByPass') {
+        Write-Host "PowerShell requires an execution policy of 'RemoteSigned'."
+        Write-Host "To make this change please run:"
+        Write-Host "'Set-ExecutionPolicy RemoteSigned -scope CurrentUser'"
+        break
+    }
+}
+
+function DownloadBinary {
+    Write-Host "[2/4] Downloading Appwrite CLI binary ..."
+    Write-Host "🚦 Fetching latest version ... " -ForegroundColor green
+
+    if((Get-CimInstance Win32_operatingsystem).OSArchitecture -like '*ARM*') {
+      Invoke-WebRequest -Uri $GITHUB_arm64_URL -OutFile $APPWRITE_DOWNLOAD_DIR
+    } else {
+      Invoke-WebRequest -Uri $GITHUB_x64_URL -OutFile $APPWRITE_DOWNLOAD_DIR
+    }
+
+    New-Item -ItemType Directory -Path $APPWRITE_INSTALL_DIR
+    Move-Item $APPWRITE_DOWNLOAD_DIR $APPWRITE_INSTALL_PATH
+}
+
+
+function Install {
+    Write-Host "[3/4] Starting installation ..."
+
+    if ($USER_PATH_ENV_VAR -like '*Appwrite*') {
+        Write-Host "Skipping to add Appwrite to User Path."
+    } else {
+        [System.Environment]::SetEnvironmentVariable("PATH", $USER_PATH_ENV_VAR + ";$APPWRITE_INSTALL_DIR", "User")
+        $env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path","User") 
+    }
+}
+
+function CleanUp {
+    Write-Host "Cleaning up mess ..."
+}
+
+function InstallCompleted {
+    Write-Host "[4/4] Finishing Installation ... "
+    cleanup
+    Write-Host "🤘 May the force be with you."
+    Write-Host "To get started with Appwrite CLI, please visit https://appwrite.io/docs/command-line"
+}
+
+
+Greeting
+CheckSystemInfo
+DownloadBinary
+Install
+CleanUp
+InstallCompleted

package/install.sh

@@ -97,15 +97,7 @@ printSuccess() {
 downloadBinary() {
     echo "[2/4] Downloading executable for $OS ($ARCH) ..."
 
-    printf "${GREEN}🚦 Fetching latest version ... ${NC}\n"
-    res=$(curl -L -s -H 'Accept: application/json' https://github.com/$GITHUB_REPOSITORY_NAME/releases/latest)
-    if [[ "$res" == *"error"* ]]; then
-        printf "${RED}❌ There was an error. Try again later.${NC} \n"
-        exit 1
-    fi
-    printSuccess
-
-    GITHUB_LATEST_VERSION=$( echo $res | sed -e 's/.*"tag_name":"\([^"]*\)".*/\1/')
+    GITHUB_LATEST_VERSION="0.17.0"
     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

@@ -1,5 +1,6 @@
 const os = require('os');
 const axios = require("axios");
+const JSONbig = require("json-bigint")({ storeAsString: false });
 const FormData = require("form-data");
 const AppwriteException = require("./exception.js");
 const { globalConfig } = require("./config.js");
@@ -11,9 +12,9 @@ class Client {
     this.endpoint = 'https://HOSTNAME/v1';
     this.headers = {
       'content-type': '',
-      'x-sdk-version': 'appwrite:cli:0.14.0',
-      'User-Agent' : `AppwriteCLI/0.14.0 (${os.type()} ${os.version()}; ${os.arch()})`,
-      'X-Appwrite-Response-Format' : '0.12.0',
+      'x-sdk-version': 'appwrite:cli:0.17.0',
+      'User-Agent' : `AppwriteCLI/0.17.0 (${os.type()} ${os.version()}; ${os.arch()})`,
+      'X-Appwrite-Response-Format' : '0.14.0',
     };
   }
 
@@ -151,7 +152,7 @@ class Client {
       process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = 0;
     }
 
-    headers = Object.assign(this.headers, headers);
+    headers = Object.assign({}, this.headers, headers);
 
     let contentType = headers["content-type"].toLowerCase();
 
@@ -180,11 +181,9 @@ class Client {
       params: method.toUpperCase() === "GET" ? params : {},
       headers: headers,
       data:
-        method.toUpperCase() === "GET" ||
-          contentType.startsWith("multipart/form-data")
-          ? formData
-          : params,
+        method.toUpperCase() === "GET" || contentType.startsWith("multipart/form-data") ? formData : params,
       json: contentType.startsWith("application/json"),
+      transformRequest: method.toUpperCase() === "GET" || contentType.startsWith("multipart/form-data") ? undefined : (data) =>  JSONbig.stringify(data),
       responseType: responseType,
     };
     try {

package/lib/commands/account.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')
@@ -65,23 +68,6 @@ const accountCreate = async ({ userId, email, password, name, parseOutput = true
     return response;
 }
 
-const accountDelete = async ({ parseOutput = true, sdk = undefined}) => {
-
-    let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/account';
-    let payload = {};
-    let response = undefined;
-    response = await client.call('delete', path, {
-        'content-type': 'application/json',
-    }, payload);
-    
-    if (parseOutput) {
-        parse(response)
-        success()
-    }
-    return response;
-}
-
 const accountUpdateEmail = async ({ email, password, parseOutput = true, sdk = undefined}) => {
     /* @param {string} email */
     /* @param {string} password */
@@ -234,7 +220,7 @@ const accountUpdatePrefs = async ({ prefs, parseOutput = true, sdk = undefined})
     
     /** Body Params */
     if (typeof prefs !== 'undefined') {
-        payload['prefs'] = prefs;
+        payload['prefs'] = JSON.parse(prefs);
     }
 
     let response = undefined;
@@ -546,6 +532,23 @@ const accountDeleteSession = async ({ sessionId, parseOutput = true, sdk = undef
     return response;
 }
 
+const accountUpdateStatus = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/account/status';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('patch', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
 const accountCreateVerification = async ({ url, parseOutput = true, sdk = undefined}) => {
     /* @param {string} url */
 
@@ -614,11 +617,6 @@ account
     .option(`--name <name>`, `User name. Max length: 128 chars.`)
     .action(actionRunner(accountCreate))
 
-account
-    .command(`delete`)
-    .description(`Delete a currently logged in user account. Behind the scene, the user record is not deleted but permanently blocked from any access. This is done to avoid deleted accounts being overtaken by new users with the same email address. Any user-related resources like documents or storage files should be deleted separately.`)
-    .action(actionRunner(accountDelete))
-
 account
     .command(`updateEmail`)
     .description(`Update currently logged in user account email address. After changing user address, the user confirmation status will get reset. A new confirmation email is not sent automatically however you can use the send confirmation email endpoint again to send the confirmation email. For security measures, user password is required to complete this request. This endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password. `)
@@ -646,7 +644,7 @@ account
 
 account
     .command(`updatePassword`)
-    .description(`Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth and Team Invites, oldPassword is optional.`)
+    .description(`Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth, Team Invites and Magic URL, oldPassword is optional.`)
     .requiredOption(`--password <password>`, `New user password. Must be at least 8 chars.`)
     .option(`--oldPassword <oldPassword>`, `Current user password. Must be at least 8 chars.`)
     .action(actionRunner(accountUpdatePassword))
@@ -718,10 +716,10 @@ 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.. `)
-    .requiredOption(`--provider <provider>`, `OAuth2 Provider. Currently, supported providers are: amazon, apple, bitbucket, bitly, box, discord, dropbox, facebook, github, gitlab, google, linkedin, microsoft, notion, paypal, paypalSandbox, salesforce, slack, spotify, tradeshift, tradeshiftBox, twitch, vk, yahoo, yammer, yandex, wordpress, stripe.`)
+    .requiredOption(`--provider <provider>`, `OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, bitbucket, bitly, box, discord, dropbox, facebook, github, gitlab, google, linkedin, microsoft, notion, okta, paypal, paypalSandbox, salesforce, slack, spotify, tradeshift, tradeshiftBox, twitch, zoom, yahoo, yammer, yandex, wordpress, stripe.`)
     .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.`)
-    .option(`--scopes <scopes...>`, `A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes.`)
+    .option(`--scopes <scopes...>`, `A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 128 characters long.`)
     .action(actionRunner(accountCreateOAuth2Session))
 
 account
@@ -732,7 +730,7 @@ account
 
 account
     .command(`updateSession`)
-    .description(``)
+    .description(`Access tokens have limited lifespan and expire to mitigate security risks. If session was created using an OAuth provider, this route can be used to "refresh" the access token.`)
     .requiredOption(`--sessionId <sessionId>`, `Session ID. Use the string 'current' to update the current device session.`)
     .action(actionRunner(accountUpdateSession))
 
@@ -742,6 +740,11 @@ account
     .requiredOption(`--sessionId <sessionId>`, `Session ID. Use the string 'current' to delete the current device session.`)
     .action(actionRunner(accountDeleteSession))
 
+account
+    .command(`updateStatus`)
+    .description(`Block the currently logged in user account. Behind the scene, the user record is not deleted but permanently blocked from any access. To completely delete a user, use the Users API instead.`)
+    .action(actionRunner(accountUpdateStatus))
+
 account
     .command(`createVerification`)
     .description(`Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the **userId** and **secret** arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the **userId** and **secret** parameters. Learn more about how to [complete the verification process](/docs/client/account#accountUpdateVerification). The verification link sent to the user's email address is valid for 7 days.  Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface. `)
@@ -760,7 +763,6 @@ module.exports = {
     account,
     accountGet,
     accountCreate,
-    accountDelete,
     accountUpdateEmail,
     accountCreateJWT,
     accountGetLogs,
@@ -780,6 +782,7 @@ module.exports = {
     accountGetSession,
     accountUpdateSession,
     accountDeleteSession,
+    accountUpdateStatus,
     accountCreateVerification,
     accountUpdateVerification
-};
+};

package/lib/commands/avatars.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')
@@ -271,7 +274,7 @@ const avatarsGetQR = async ({ text, size, margin, download, parseOutput = true,
 
 avatars
     .command(`getBrowser`)
-    .description(`You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user /account/sessions endpoint. Use width, height and quality arguments to change the output settings.`)
+    .description(`You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET /account/sessions](/docs/client/account#accountGetSessions) endpoint. Use width, height and quality arguments to change the output settings.  When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.`)
     .requiredOption(`--code <code>`, `Browser Code.`)
     .option(`--width <width>`, `Image width. Pass an integer between 0 to 2000. Defaults to 100.`, parseInteger)
     .option(`--height <height>`, `Image height. Pass an integer between 0 to 2000. Defaults to 100.`, parseInteger)
@@ -281,7 +284,7 @@ avatars
 
 avatars
     .command(`getCreditCard`)
-    .description(`The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.`)
+    .description(`The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.  When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px. `)
     .requiredOption(`--code <code>`, `Credit Card Code. Possible values: amex, argencard, cabal, censosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.`)
     .option(`--width <width>`, `Image width. Pass an integer between 0 to 2000. Defaults to 100.`, parseInteger)
     .option(`--height <height>`, `Image height. Pass an integer between 0 to 2000. Defaults to 100.`, parseInteger)
@@ -298,7 +301,7 @@ avatars
 
 avatars
     .command(`getFlag`)
-    .description(`You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings.`)
+    .description(`You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings.  When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px. `)
     .requiredOption(`--code <code>`, `Country Code. ISO Alpha-2 country code format.`)
     .option(`--width <width>`, `Image width. Pass an integer between 0 to 2000. Defaults to 100.`, parseInteger)
     .option(`--height <height>`, `Image height. Pass an integer between 0 to 2000. Defaults to 100.`, parseInteger)
@@ -308,16 +311,16 @@ avatars
 
 avatars
     .command(`getImage`)
-    .description(`Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.`)
+    .description(`Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.  When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px. `)
     .requiredOption(`--url <url>`, `Image URL which you want to crop.`)
-    .option(`--width <width>`, `Resize preview image width, Pass an integer between 0 to 2000.`, parseInteger)
-    .option(`--height <height>`, `Resize preview image height, Pass an integer between 0 to 2000.`, parseInteger)
+    .option(`--width <width>`, `Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.`, parseInteger)
+    .option(`--height <height>`, `Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.`, parseInteger)
     .requiredOption(`--destination <path>`, `output file path.`)
     .action(actionRunner(avatarsGetImage))
 
 avatars
     .command(`getInitials`)
-    .description(`Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.  You can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.`)
+    .description(`Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.  You can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.  When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px. `)
     .option(`--name <name>`, `Full Name. When empty, current user name or email will be used. Max length: 128 chars.`)
     .option(`--width <width>`, `Image width. Pass an integer between 0 to 2000. Defaults to 100.`, parseInteger)
     .option(`--height <height>`, `Image height. Pass an integer between 0 to 2000. Defaults to 100.`, parseInteger)
@@ -328,9 +331,9 @@ avatars
 
 avatars
     .command(`getQR`)
-    .description(`Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.`)
+    .description(`Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image. `)
     .requiredOption(`--text <text>`, `Plain text to be converted to QR code image.`)
-    .option(`--size <size>`, `QR code size. Pass an integer between 0 to 1000. Defaults to 400.`, parseInteger)
+    .option(`--size <size>`, `QR code size. Pass an integer between 1 to 1000. Defaults to 400.`, parseInteger)
     .option(`--margin <margin>`, `Margin from edge. Pass an integer between 0 to 10. Defaults to 1.`, parseInteger)
     .option(`--download <download>`, `Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.`, parseBool)
     .requiredOption(`--destination <path>`, `output file path.`)
@@ -346,4 +349,4 @@ module.exports = {
     avatarsGetImage,
     avatarsGetInitials,
     avatarsGetQR
-};
+};