Appwrite Command Line SDK

This SDK is compatible with Appwrite server version 0.7.0. 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

Installation

This tutorial assumes that you have docker setup and running on your machine.

You can install the CLI by getting our installation script.

Linux / MacOS

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

Windows

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

Initialisation

The CLI needs to be initialised with your project settings. This can be done using

$ appwrite init 

The CLI requires an endpoint, project ID, API key and a locale to be able to communicate with the Appwrite backend server. There are two ways to achieve this

1. Environment file

$ appwrite --env-file path/to/your/environment/file init     

The .env file must have the following keys

endpoint=http://192.168.1.6/v1
X-Appwrite-Project=5ff450422d42f
X-Appwrite-Key=0773c7...a2672a
X-Appwrite-Locale=en-US

2. Using the prompt

Invoking appwrite init without an env file triggers an interactive prompt where you can manually enter the details. These values are saved locally so that you dont have to re-enter them everytime.

Usage

The Appwrite CLI follows the following general syntax.

$ appwrite [SERVICE] [COMMAND] --[OPTIONS]

A few sample commands to get you started

$ appwrite users create --email="hello@appwrite.io" --password="very_strong_password"
$ appwrite users list 

To get information about the different services available, you can use

$ appwrite help

To get information about a particular service and the commands available in a service you can use

$ appwrite users help
$ appwrite accounts help

To get information about a particular command and the parameters it accepts, you can use

$ appwrite users list --help
$ appwrite account get --help 

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.

License

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