appwrite-cli 0.14.0 → 0.15.0

package/.github/workflows/npm-publish.yml

@@ -13,6 +13,7 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
       - name: Setup binfmt with QEMU
         run: | 
+          sudo apt update
           sudo apt install qemu binfmt-support qemu-user-static
           update-binfmts --display
       - name: Setup ldid

package/README.md

@@ -1,7 +1,7 @@
 # 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.13.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)
@@ -29,7 +29,7 @@ Once the installation is complete, you can verify the install using
 
 ```sh
 $ appwrite -v
-0.14.0
+0.15.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.15.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/install.ps1

@@ -0,0 +1,94 @@
+## <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.15.0/appwrite-cli-win-x64.exe"
+$GITHUB_arm64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/0.15.0/appwrite-cli-win-arm64.exe"
+
+# Appwrite download directory
+$APPWRITE_DOWNLOAD_DIR = Join-Path -Path $env:TEMP -ChildPath "appwrite.exe"
+
+# Appwrite CLI location
+$APPWRITE_INSTALL_DIR = Join-Path -Path $env:LOCALAPPDATA -ChildPath "Appwrite"
+
+$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
+    }
+   
+
+   Move-Item $APPWRITE_DOWNLOAD_DIR $APPWRITE_INSTALL_DIR
+}
+
+
+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")
+    }
+}
+
+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.15.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

@@ -11,9 +11,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.15.0',
+      'User-Agent' : `AppwriteCLI/0.15.0 (${os.type()} ${os.version()}; ${os.arch()})`,
+      'X-Appwrite-Response-Format' : '0.13.0',
     };
   }
 
@@ -151,7 +151,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();
 

package/lib/commands/account.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
+const tar = require("tar");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')

package/lib/commands/avatars.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
+const tar = require("tar");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')

package/lib/commands/database.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
+const tar = require("tar");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')

package/lib/commands/deploy.js

@@ -167,7 +167,7 @@ const deployFunction = async () => {
                 functionId: func['$id'],
                 name: func.name,
                 execute: func.execute,
-                vars: func.vars,
+                vars: response.vars,
                 events: func.events,
                 schedule: func.schedule,
                 timeout: func.timeout,

package/lib/commands/functions.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
+const tar = require("tar");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -261,7 +261,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,7 +276,14 @@ 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' });
+    
+    await tar
+        .create({
+            gzip: true,
+            sync: true,
+            cwd: folderPath,
+            file: 'code.tar.gz'
+        }, ['./'])
     let archivePath = fs.realpathSync('code.tar.gz')
     if (typeof archivePath !== 'undefined') {
         payload['code'] = archivePath;
@@ -326,7 +333,13 @@ const functionsCreateDeployment = async ({ functionId, entrypoint, code, activat
                 }
 
                 if (onProgress !== null) {
-                        onProgress(Math.min((counter+1) * libClient.CHUNK_SIZE, size) / size * 100);
+                    onProgress({
+                        $id: response['$id'],
+                        progress: Math.min((counter+1) * libClient.CHUNK_SIZE, size) / size * 100,
+                        sizeUploaded: end+1,
+                        chunksTotal: response['chunksTotal'],
+                        chunksUploaded: response['chunksUploaded']
+                    });
                 }
         }
     }
@@ -557,7 +570,7 @@ functions
 
 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

package/lib/commands/health.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
+const tar = require("tar");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')

package/lib/commands/init.js

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

package/lib/commands/locale.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
+const tar = require("tar");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')

package/lib/commands/projects.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
+const tar = require("tar");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')

package/lib/commands/storage.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
+const tar = require("tar");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -269,7 +269,7 @@ const storageListFiles = async ({ bucketId, search, limit, offset, cursor, curso
 const storageCreateFile = async ({ bucketId, fileId, file, read, write, parseOutput = true, sdk = undefined, onProgress = () => {}}) => {
     /* @param {string} bucketId */
     /* @param {string} fileId */
-    /* @param {File} file */
+    /* @param {string} file */
     /* @param {string[]} read */
     /* @param {string[]} write */
 
@@ -335,7 +335,13 @@ const storageCreateFile = async ({ bucketId, fileId, file, read, write, parseOut
                 }
 
                 if (onProgress !== null) {
-                        onProgress(Math.min((counter+1) * libClient.CHUNK_SIZE, size) / size * 100);
+                    onProgress({
+                        $id: response['$id'],
+                        progress: Math.min((counter+1) * libClient.CHUNK_SIZE, size) / size * 100,
+                        sizeUploaded: end+1,
+                        chunksTotal: response['chunksTotal'],
+                        chunksUploaded: response['chunksUploaded']
+                    });
                 }
         }
     }
@@ -440,7 +446,7 @@ const storageGetFileDownload = async ({ bucketId, fileId, parseOutput = true, sd
     }
 }
 
-const storageGetFilePreview = async ({ bucketId, fileId, width, height, gravity, quality, borderWidth, borderColor, borderRadius, opacity, rotation, background, output, parseOutput = true, sdk = undefined}) => {
+const storageGetFilePreview = async ({ bucketId, fileId, width, height, gravity, quality, borderWidth, borderColor, borderRadius, opacity, rotation, background, output, parseOutput = true, sdk = undefined, destination}) => {
     /* @param {string} bucketId */
     /* @param {string} fileId */
     /* @param {number} width */
@@ -493,16 +499,21 @@ const storageGetFilePreview = async ({ bucketId, fileId, width, height, gravity,
     if (typeof output !== 'undefined') {
         payload['output'] = output;
     }
-    let response = undefined;
-    response = await client.call('get', path, {
+    payload['project'] = localConfig.getProject().projectId
+    payload['key'] = globalConfig.getKey();
+    const queryParams = new URLSearchParams(payload);
+    path = `${globalConfig.getEndpoint()}${path}?${queryParams.toString()}`;
+
+    const response = await client.call('get', path, {
         'content-type': 'application/json',
-    }, payload);
-    
-    if (parseOutput) {
-        parse(response)
+    }, payload, 'arraybuffer');
+
+    fs.writeFileSync(destination, response);
+
+    if (parseOutput) { 
+        log(`File stored in ${destination}`)
         success()
     }
-    return response;
 }
 
 const storageGetFileView = async ({ bucketId, fileId, parseOutput = true, sdk = undefined, destination}) => {
@@ -699,6 +710,7 @@ storage
     .option(`--rotation <rotation>`, `Preview image rotation in degrees. Pass an integer between -360 and 360.`, parseInteger)
     .option(`--background <background>`, `Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.`)
     .option(`--output <output>`, `Output format type (jpeg, jpg, png, gif and webp).`)
+    .requiredOption(`--destination <path>`, `output file path.`)
     .action(actionRunner(storageGetFilePreview))
 
 storage

package/lib/commands/teams.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
+const tar = require("tar");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')

package/lib/commands/users.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
+const tar = require("tar");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const childProcess = require('child_process');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')

package/package.json

@@ -2,7 +2,7 @@
   "name": "appwrite-cli",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "license": "BSD-3-Clause",
   "main": "index.js",
   "bin": {
@@ -27,7 +27,8 @@
     "cli-table3": "^0.6.1",
     "commander": "^8.3.0",
     "form-data": "^4.0.0",
-    "inquirer": "^8.2.0"
+    "inquirer": "^8.2.0",
+    "tar": "^6.1.11"
   },
   "devDependencies": {
     "pkg": "5.5.1"