Home

Awesome

Appwrite Command Line SDK

License Version Build Status Twitter Account Discord

This SDK is compatible with Appwrite server version 0.13.x. For older versions, please check previous 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

Appwrite

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 as well as pre built binaries for specific operating systems and architectures.

Install using NPM

If you have npm installed, it's as easy as running

$ npm install -g appwrite-cli

Once the installation is complete, you can verify the install using

$ appwrite -v
0.15.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

$ wget -q https://appwrite.io/cli/install.sh  -O - | /bin/bash

MacOS via Homebrew

$ 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

$ iwr -useb https://appwrite.io/cli/install.ps1 | iex

Once the installation completes, you can verify your install using

$ appwrite -v
0.15.0

Contribution

This library is auto-generated by Appwrite custom SDK Generator. To learn more about how you can help us improve this SDK, please check the contribution guide 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
$ git clone https://github.com/appwrite/sdk-generator
$ cd sdk-generator
  1. Ensure Docker is running locally and then install the composer dependencies using
$ 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
  1. Head over to the generated SDK and install the dependencies.
$ cd examples/cli
$ npm install
  1. Install the CLI using
$ npm install -g .
  1. You can now use the CLI
$ appwrite -v

License

Please see the BSD-3-Clause license file for more information.