appwrite-cli 0.14.0

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

@@ -0,0 +1,41 @@
+name: Publish Package to npmjs
+on:
+  release:
+    types: [published]
+jobs:
+  build-for-linux-and-windows:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Setup binfmt with QEMU
+        run: | 
+          sudo apt install qemu binfmt-support qemu-user-static
+          update-binfmts --display
+      - name: Setup ldid
+        run: |
+          git clone https://github.com/tpoechtrager/ldid
+          cd ./ldid
+          sudo make
+          sudo make install
+      - name: Install dependenices and build for Linux and Windows
+        run: | 
+          npm install
+          npm run linux-x64
+          npm run linux-arm64
+          npm run windows-x64
+          npm run windows-arm64
+          npm run mac-x64
+          npm run mac-arm64
+      - name: Publish NPM library
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - uses: fnkr/github-action-ghr@v1
+        env:
+          GHR_PATH: build/
+          GHR_REPLACE: false
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}

package/Formula/appwrite.rb

@@ -0,0 +1,19 @@
+require "language/node"
+
+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"
+
+  depends_on "node"
+
+  def install
+    system "npm", "install", *Language::Node.std_npm_install_args(libexec)
+    bin.install_symlink Dir["#{libexec}/bin/*"]
+  end
+
+  test do
+    system "true"
+  end
+end

package/LICENSE.md

@@ -0,0 +1,12 @@
+Copyright (c) 2022 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:
+
+    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+    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.
+
+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

@@ -0,0 +1,102 @@
+# 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)
+[![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).**
+
+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)
+
+![Appwrite](https://appwrite.io/images/github.png)
+
+## Installation
+
+The Appwrite CLI is a Node based command line tool to help you interact with the Appwrite API. The CLI is distributed both as an [`npm package`](https://www.npmjs.com/package/appwrite-cli) as well as [pre built binaries](https://github.com/appwrite/sdk-for-cli/releases/latest) for specific operating systems and architectures.
+
+### Install using NPM
+---
+
+If you have `npm` installed, it's as easy as running
+
+```sh
+$ npm install -g appwrite-cli
+```
+
+Once the installation is complete, you can verify the install using
+
+```sh
+$ appwrite -v
+0.14.0
+```
+
+### Install using prebuilt binaries
+---
+
+If you do not have `npm` installed, you can always install the prebuilt binaries for your architecture and OS using our convenient installation scripts.
+
+### Linux / MacOS Terminal
+```bash
+$ wget -q https://appwrite.io/cli/install.sh  -O - | /bin/bash
+```
+
+### MacOS via [Homebrew](https://brew.sh)
+```bash
+$ brew tap appwrite/sdk-for-cli https://github.com/appwrite/sdk-for-cli
+$ brew update
+$ brew install --HEAD appwrite 
+```
+> Please note that `--HEAD` will be removed with official release.
+
+### Windows
+```powershell
+$ iwr -useb https://appwrite.io/cli/install.ps1 | iex
+```
+
+Once the installation completes, you can verify your install using
+```
+$ appwrite -v
+0.14.0
+```
+
+
+## Contribution
+
+This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
+
+To build and test the CLI for development, follow these steps 
+
+1. Clone the SDK Generator repository and cd into the directory
+```sh
+$ git clone https://github.com/appwrite/sdk-generator
+$ cd sdk-generator
+```
+
+2. Ensure Docker is running locally and then install the composer dependencies using
+```sh 
+$ docker run --rm --interactive --tty --volume "$(pwd)":/app composer install --ignore-platform-reqs --optimize-autoloader --no-plugins --no-scripts --prefer-dist
+
+# Generate the SDKs
+$ docker run --rm -v $(pwd):/app -w /app php:7.4-cli php example.php
+```
+
+3. Head over to the generated SDK and install the dependencies.
+```sh
+$ cd examples/cli
+$ npm install 
+```
+
+4. Install the CLI using 
+```sh
+$ npm install -g .
+```
+
+5. You can now use the CLI 
+```sh
+$ appwrite -v
+```
+## License
+
+Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.

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

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

package/docs/examples/account/create-j-w-t.md

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

package/docs/examples/account/create-magic-u-r-l-session.md

@@ -0,0 +1,4 @@
+appwrite account createMagicURLSession \
+        --userId [USER_ID] \
+        --email email@example.com \
+

package/docs/examples/account/create-o-auth2session.md

@@ -0,0 +1,5 @@
+appwrite account createOAuth2Session \
+        --provider amazon \
+
+
+

package/docs/examples/account/create-recovery.md

@@ -0,0 +1,3 @@
+appwrite account createRecovery \
+        --email email@example.com \
+        --url https://example.com

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

@@ -0,0 +1,3 @@
+appwrite account createSession \
+        --email email@example.com \
+        --password password

package/docs/examples/account/create-verification.md

@@ -0,0 +1,2 @@
+appwrite account createVerification \
+        --url https://example.com

package/docs/examples/account/create.md

@@ -0,0 +1,5 @@
+appwrite account create \
+        --userId [USER_ID] \
+        --email email@example.com \
+        --password password \
+

package/docs/examples/account/delete-session.md

@@ -0,0 +1,2 @@
+appwrite account deleteSession \
+        --sessionId [SESSION_ID]

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

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

package/docs/examples/account/delete.md

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

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

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

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

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

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

@@ -0,0 +1,2 @@
+appwrite account getSession \
+        --sessionId [SESSION_ID]

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

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

package/docs/examples/account/get.md

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

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

@@ -0,0 +1,3 @@
+appwrite account updateEmail \
+        --email email@example.com \
+        --password password

package/docs/examples/account/update-magic-u-r-l-session.md

@@ -0,0 +1,3 @@
+appwrite account updateMagicURLSession \
+        --userId [USER_ID] \
+        --secret [SECRET]

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

@@ -0,0 +1,2 @@
+appwrite account updateName \
+        --name [NAME]

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

@@ -0,0 +1,3 @@
+appwrite account updatePassword \
+        --password password \
+

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

@@ -0,0 +1,2 @@
+appwrite account updatePrefs \
+        --prefs '{ "key": "value" }'

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

@@ -0,0 +1,5 @@
+appwrite account updateRecovery \
+        --userId [USER_ID] \
+        --secret [SECRET] \
+        --password password \
+        --passwordAgain password

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

@@ -0,0 +1,2 @@
+appwrite account updateSession \
+        --sessionId [SESSION_ID]

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

@@ -0,0 +1,3 @@
+appwrite account updateVerification \
+        --userId [USER_ID] \
+        --secret [SECRET]

package/docs/examples/avatars/get-browser.md

@@ -0,0 +1,5 @@
+appwrite avatars getBrowser \
+        --code aa \
+
+
+

package/docs/examples/avatars/get-credit-card.md

@@ -0,0 +1,5 @@
+appwrite avatars getCreditCard \
+        --code amex \
+
+
+

package/docs/examples/avatars/get-favicon.md

@@ -0,0 +1,2 @@
+appwrite avatars getFavicon \
+        --url https://example.com

package/docs/examples/avatars/get-flag.md

@@ -0,0 +1,5 @@
+appwrite avatars getFlag \
+        --code af \
+
+
+

package/docs/examples/avatars/get-image.md

@@ -0,0 +1,4 @@
+appwrite avatars getImage \
+        --url https://example.com \
+
+

package/docs/examples/avatars/get-initials.md

@@ -0,0 +1,6 @@
+appwrite avatars getInitials \
+
+
+
+
+

package/docs/examples/avatars/get-q-r.md

@@ -0,0 +1,5 @@
+appwrite avatars getQR \
+        --text [TEXT] \
+
+
+

package/docs/examples/database/create-boolean-attribute.md

@@ -0,0 +1,6 @@
+appwrite database createBooleanAttribute \
+        --collectionId [COLLECTION_ID] \
+        --key '' \
+        --required false \
+
+

package/docs/examples/database/create-collection.md

@@ -0,0 +1,6 @@
+appwrite database createCollection \
+        --collectionId [COLLECTION_ID] \
+        --name [NAME] \
+        --permission document \
+        --read "role:all" \
+        --write "role:all"

package/docs/examples/database/create-document.md

@@ -0,0 +1,6 @@
+appwrite database createDocument \
+        --collectionId [COLLECTION_ID] \
+        --documentId [DOCUMENT_ID] \
+        --data '{ "key": "value" }' \
+
+

package/docs/examples/database/create-email-attribute.md

@@ -0,0 +1,6 @@
+appwrite database createEmailAttribute \
+        --collectionId [COLLECTION_ID] \
+        --key '' \
+        --required false \
+
+

package/docs/examples/database/create-enum-attribute.md

@@ -0,0 +1,7 @@
+appwrite database createEnumAttribute \
+        --collectionId [COLLECTION_ID] \
+        --key '' \
+        --elements one two three \
+        --required false \
+
+

package/docs/examples/database/create-float-attribute.md

@@ -0,0 +1,8 @@
+appwrite database createFloatAttribute \
+        --collectionId [COLLECTION_ID] \
+        --key '' \
+        --required false \
+
+
+
+

package/docs/examples/database/create-index.md

@@ -0,0 +1,6 @@
+appwrite database createIndex \
+        --collectionId [COLLECTION_ID] \
+        --key '' \
+        --type key \
+        --attributes one two three \
+

package/docs/examples/database/create-integer-attribute.md

@@ -0,0 +1,8 @@
+appwrite database createIntegerAttribute \
+        --collectionId [COLLECTION_ID] \
+        --key '' \
+        --required false \
+
+
+
+

package/docs/examples/database/create-ip-attribute.md

@@ -0,0 +1,6 @@
+appwrite database createIpAttribute \
+        --collectionId [COLLECTION_ID] \
+        --key '' \
+        --required false \
+
+

package/docs/examples/database/create-string-attribute.md

@@ -0,0 +1,7 @@
+appwrite database createStringAttribute \
+        --collectionId [COLLECTION_ID] \
+        --key '' \
+        --size 1 \
+        --required false \
+
+

package/docs/examples/database/create-url-attribute.md

@@ -0,0 +1,6 @@
+appwrite database createUrlAttribute \
+        --collectionId [COLLECTION_ID] \
+        --key '' \
+        --required false \
+
+

package/docs/examples/database/delete-attribute.md

@@ -0,0 +1,3 @@
+appwrite database deleteAttribute \
+        --collectionId [COLLECTION_ID] \
+        --key ''

package/docs/examples/database/delete-collection.md

@@ -0,0 +1,2 @@
+appwrite database deleteCollection \
+        --collectionId [COLLECTION_ID]

package/docs/examples/database/delete-document.md

@@ -0,0 +1,3 @@
+appwrite database deleteDocument \
+        --collectionId [COLLECTION_ID] \
+        --documentId [DOCUMENT_ID]

package/docs/examples/database/delete-index.md

@@ -0,0 +1,3 @@
+appwrite database deleteIndex \
+        --collectionId [COLLECTION_ID] \
+        --key ''

package/docs/examples/database/get-attribute.md

@@ -0,0 +1,3 @@
+appwrite database getAttribute \
+        --collectionId [COLLECTION_ID] \
+        --key ''

package/docs/examples/database/get-collection-usage.md

@@ -0,0 +1,3 @@
+appwrite database getCollectionUsage \
+        --collectionId [COLLECTION_ID] \
+

package/docs/examples/database/get-collection.md

@@ -0,0 +1,2 @@
+appwrite database getCollection \
+        --collectionId [COLLECTION_ID]

package/docs/examples/database/get-document.md

@@ -0,0 +1,3 @@
+appwrite database getDocument \
+        --collectionId [COLLECTION_ID] \
+        --documentId [DOCUMENT_ID]

package/docs/examples/database/get-index.md

@@ -0,0 +1,3 @@
+appwrite database getIndex \
+        --collectionId [COLLECTION_ID] \
+        --key ''

package/docs/examples/database/get-usage.md

@@ -0,0 +1,2 @@
+appwrite database getUsage \
+

package/docs/examples/database/list-attributes.md

@@ -0,0 +1,2 @@
+appwrite database listAttributes \
+        --collectionId [COLLECTION_ID]

package/docs/examples/database/list-collection-logs.md

@@ -0,0 +1,4 @@
+appwrite database listCollectionLogs \
+        --collectionId [COLLECTION_ID] \
+
+

package/docs/examples/database/list-collections.md

@@ -0,0 +1,7 @@
+appwrite database listCollections \
+
+
+
+
+
+

package/docs/examples/database/list-document-logs.md

@@ -0,0 +1,5 @@
+appwrite database listDocumentLogs \
+        --collectionId [COLLECTION_ID] \
+        --documentId [DOCUMENT_ID] \
+
+

package/docs/examples/database/list-documents.md

@@ -0,0 +1,9 @@
+appwrite database listDocuments \
+        --collectionId [COLLECTION_ID] \
+
+
+
+
+
+
+

package/docs/examples/database/list-indexes.md

@@ -0,0 +1,2 @@
+appwrite database listIndexes \
+        --collectionId [COLLECTION_ID]

package/docs/examples/database/update-collection.md

@@ -0,0 +1,7 @@
+appwrite database updateCollection \
+        --collectionId [COLLECTION_ID] \
+        --name [NAME] \
+        --permission document \
+
+
+

package/docs/examples/database/update-document.md

@@ -0,0 +1,6 @@
+appwrite database updateDocument \
+        --collectionId [COLLECTION_ID] \
+        --documentId [DOCUMENT_ID] \
+        --data '{ "key": "value" }' \
+
+

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

@@ -0,0 +1,5 @@
+appwrite functions createDeployment \
+        --functionId [FUNCTION_ID] \
+        --entrypoint [ENTRYPOINT] \
+        --code 'path/to/file.png' \
+        --activate false

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

@@ -0,0 +1,4 @@
+appwrite functions createExecution \
+        --functionId [FUNCTION_ID] \
+
+

package/docs/examples/functions/create.md

@@ -0,0 +1,9 @@
+appwrite functions create \
+        --functionId [FUNCTION_ID] \
+        --name [NAME] \
+        --execute one two three \
+        --runtime node-14.5 \
+
+
+
+

package/docs/examples/functions/delete-deployment.md

@@ -0,0 +1,3 @@
+appwrite functions deleteDeployment \
+        --functionId [FUNCTION_ID] \
+        --deploymentId [DEPLOYMENT_ID]

package/docs/examples/functions/delete.md

@@ -0,0 +1,2 @@
+appwrite functions delete \
+        --functionId [FUNCTION_ID]

package/docs/examples/functions/get-deployment.md

@@ -0,0 +1,3 @@
+appwrite functions getDeployment \
+        --functionId [FUNCTION_ID] \
+        --deploymentId [DEPLOYMENT_ID]

package/docs/examples/functions/get-execution.md

@@ -0,0 +1,3 @@
+appwrite functions getExecution \
+        --functionId [FUNCTION_ID] \
+        --executionId [EXECUTION_ID]

package/docs/examples/functions/get-usage.md

@@ -0,0 +1,3 @@
+appwrite functions getUsage \
+        --functionId [FUNCTION_ID] \
+

package/docs/examples/functions/get.md

@@ -0,0 +1,2 @@
+appwrite functions get \
+        --functionId [FUNCTION_ID]

package/docs/examples/functions/list-deployments.md

@@ -0,0 +1,8 @@
+appwrite functions listDeployments \
+        --functionId [FUNCTION_ID] \
+
+
+
+
+
+

package/docs/examples/functions/list-executions.md

@@ -0,0 +1,7 @@
+appwrite functions listExecutions \
+        --functionId [FUNCTION_ID] \
+
+
+
+
+

package/docs/examples/functions/list-runtimes.md

@@ -0,0 +1 @@
+appwrite functions listRuntimes

package/docs/examples/functions/list.md

@@ -0,0 +1,7 @@
+appwrite functions list \
+
+
+
+
+
+

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

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

package/docs/examples/functions/update-deployment.md

@@ -0,0 +1,3 @@
+appwrite functions updateDeployment \
+        --functionId [FUNCTION_ID] \
+        --deploymentId [DEPLOYMENT_ID]