Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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-1.7.4-blue.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.8.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 1.7.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-cli/releases).**
**This SDK is compatible with Appwrite server version 1.8.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)

Expand All @@ -29,7 +29,7 @@ Once the installation is complete, you can verify the install using

```sh
$ appwrite -v
8.3.0
9.0.0
```

### Install using prebuilt binaries
Expand All @@ -54,13 +54,13 @@ $ iwr -useb https://appwrite.io/cli/install.ps1 | iex
```
Via [Scoop](https://scoop.sh)
```powershell
$ scoop install https://raw.githubusercontent.com/appwrite/sdk-for-cli/master/scoop/appwrite.json
$ scoop install https://raw.githubusercontent.com/appwrite/sdk-for-cli/master/scoop/appwrite.config.json
```

Once the installation completes, you can verify your install using
```
$ appwrite -v
8.3.0
9.0.0
```

## Getting Started
Expand Down
2 changes: 2 additions & 0 deletions docs/examples/account/create-m-f-a-authenticator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
appwrite account createMFAAuthenticator \
--type totp
2 changes: 2 additions & 0 deletions docs/examples/account/create-m-f-a-challenge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
appwrite account createMFAChallenge \
--factor email
1 change: 1 addition & 0 deletions docs/examples/account/create-m-f-a-recovery-codes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
appwrite account createMFARecoveryCodes
2 changes: 2 additions & 0 deletions docs/examples/account/delete-m-f-a-authenticator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
appwrite account deleteMFAAuthenticator \
--type totp
1 change: 1 addition & 0 deletions docs/examples/account/get-m-f-a-recovery-codes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
appwrite account getMFARecoveryCodes
1 change: 1 addition & 0 deletions docs/examples/account/list-m-f-a-factors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
appwrite account listMFAFactors
3 changes: 3 additions & 0 deletions docs/examples/account/update-m-f-a-authenticator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
appwrite account updateMFAAuthenticator \
--type totp \
--otp <OTP>
3 changes: 3 additions & 0 deletions docs/examples/account/update-m-f-a-challenge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
appwrite account updateMFAChallenge \
--challengeId <CHALLENGE_ID> \
--otp <OTP>
1 change: 1 addition & 0 deletions docs/examples/account/update-m-f-a-recovery-codes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
appwrite account updateMFARecoveryCodes
1 change: 1 addition & 0 deletions docs/examples/databases/get-usage.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
appwrite databases getUsage \
--databaseId <DATABASE_ID> \

2 changes: 2 additions & 0 deletions docs/examples/databases/list-usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
appwrite databases listUsage \

9 changes: 9 additions & 0 deletions docs/examples/messaging/create-a-p-n-s-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
appwrite messaging createAPNSProvider \
--providerId <PROVIDER_ID> \
--name <NAME> \






5 changes: 5 additions & 0 deletions docs/examples/messaging/create-f-c-m-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
appwrite messaging createFCMProvider \
--providerId <PROVIDER_ID> \
--name <NAME> \


8 changes: 8 additions & 0 deletions docs/examples/messaging/create-s-m-s.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
appwrite messaging createSMS \
--messageId <MESSAGE_ID> \
--content <CONTENT> \





15 changes: 15 additions & 0 deletions docs/examples/messaging/create-s-m-t-p-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
appwrite messaging createSMTPProvider \
--providerId <PROVIDER_ID> \
--name <NAME> \
--host <HOST> \











9 changes: 9 additions & 0 deletions docs/examples/messaging/update-a-p-n-s-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
appwrite messaging updateAPNSProvider \
--providerId <PROVIDER_ID> \







5 changes: 5 additions & 0 deletions docs/examples/messaging/update-f-c-m-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
appwrite messaging updateFCMProvider \
--providerId <PROVIDER_ID> \



8 changes: 8 additions & 0 deletions docs/examples/messaging/update-s-m-s.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
appwrite messaging updateSMS \
--messageId <MESSAGE_ID> \






15 changes: 15 additions & 0 deletions docs/examples/messaging/update-s-m-t-p-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
appwrite messaging updateSMTPProvider \
--providerId <PROVIDER_ID> \













3 changes: 2 additions & 1 deletion docs/examples/migrations/create-csv-migration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
appwrite migrations createCsvMigration \
--bucketId <BUCKET_ID> \
--fileId <FILE_ID> \
--resourceId [ID1:ID2]
--resourceId [ID1:ID2] \

11 changes: 11 additions & 0 deletions docs/examples/projects/create-s-m-t-p-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
appwrite projects createSMTPTest \
--projectId <PROJECT_ID> \
--emails one two three \
--senderName <SENDER_NAME> \
--senderEmail [email protected] \
--host '' \





4 changes: 4 additions & 0 deletions docs/examples/projects/delete-s-m-s-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
appwrite projects deleteSMSTemplate \
--projectId <PROJECT_ID> \
--type verification \
--locale af
4 changes: 4 additions & 0 deletions docs/examples/projects/get-s-m-s-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
appwrite projects getSMSTemplate \
--projectId <PROJECT_ID> \
--type verification \
--locale af
3 changes: 3 additions & 0 deletions docs/examples/projects/update-a-p-i-status-all.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
appwrite projects updateAPIStatusAll \
--projectId <PROJECT_ID> \
--status false
4 changes: 4 additions & 0 deletions docs/examples/projects/update-a-p-i-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
appwrite projects updateAPIStatus \
--projectId <PROJECT_ID> \
--api rest \
--status false
5 changes: 5 additions & 0 deletions docs/examples/projects/update-s-m-s-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
appwrite projects updateSMSTemplate \
--projectId <PROJECT_ID> \
--type verification \
--locale af \
--message <MESSAGE>
11 changes: 11 additions & 0 deletions docs/examples/projects/update-s-m-t-p.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
appwrite projects updateSMTP \
--projectId <PROJECT_ID> \
--enabled false \








3 changes: 3 additions & 0 deletions docs/examples/projects/update-session-invalidation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
appwrite projects updateSessionInvalidation \
--projectId <PROJECT_ID> \
--enabled false
7 changes: 7 additions & 0 deletions docs/examples/tablesdb/create-boolean-column.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
appwrite tablesDB createBooleanColumn \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--key '' \
--required false \


7 changes: 7 additions & 0 deletions docs/examples/tablesdb/create-datetime-column.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
appwrite tablesDB createDatetimeColumn \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--key '' \
--required false \


7 changes: 7 additions & 0 deletions docs/examples/tablesdb/create-email-column.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
appwrite tablesDB createEmailColumn \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--key '' \
--required false \


8 changes: 8 additions & 0 deletions docs/examples/tablesdb/create-enum-column.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
appwrite tablesDB createEnumColumn \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--key '' \
--elements one two three \
--required false \


9 changes: 9 additions & 0 deletions docs/examples/tablesdb/create-float-column.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
appwrite tablesDB createFloatColumn \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--key '' \
--required false \




8 changes: 8 additions & 0 deletions docs/examples/tablesdb/create-index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
appwrite tablesDB createIndex \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--key '' \
--type key \
--columns one two three \


9 changes: 9 additions & 0 deletions docs/examples/tablesdb/create-integer-column.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
appwrite tablesDB createIntegerColumn \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--key '' \
--required false \




7 changes: 7 additions & 0 deletions docs/examples/tablesdb/create-ip-column.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
appwrite tablesDB createIpColumn \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--key '' \
--required false \


9 changes: 9 additions & 0 deletions docs/examples/tablesdb/create-relationship-column.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
appwrite tablesDB createRelationshipColumn \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--relatedTableId <RELATED_TABLE_ID> \
--type oneToOne \




6 changes: 6 additions & 0 deletions docs/examples/tablesdb/create-row.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
appwrite tablesDB createRow \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--rowId <ROW_ID> \
--data '{ "key": "value" }' \

4 changes: 4 additions & 0 deletions docs/examples/tablesdb/create-rows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
appwrite tablesDB createRows \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--rows one two three
9 changes: 9 additions & 0 deletions docs/examples/tablesdb/create-string-column.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
appwrite tablesDB createStringColumn \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--key '' \
--size 1 \
--required false \



7 changes: 7 additions & 0 deletions docs/examples/tablesdb/create-table.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
appwrite tablesDB createTable \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--name <NAME> \



7 changes: 7 additions & 0 deletions docs/examples/tablesdb/create-url-column.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
appwrite tablesDB createUrlColumn \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--key '' \
--required false \


4 changes: 4 additions & 0 deletions docs/examples/tablesdb/create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
appwrite tablesDB create \
--databaseId <DATABASE_ID> \
--name <NAME> \

7 changes: 7 additions & 0 deletions docs/examples/tablesdb/decrement-row-column.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
appwrite tablesDB decrementRowColumn \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--rowId <ROW_ID> \
--column '' \


4 changes: 4 additions & 0 deletions docs/examples/tablesdb/delete-column.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
appwrite tablesDB deleteColumn \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--key ''
4 changes: 4 additions & 0 deletions docs/examples/tablesdb/delete-index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
appwrite tablesDB deleteIndex \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--key ''
4 changes: 4 additions & 0 deletions docs/examples/tablesdb/delete-row.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
appwrite tablesDB deleteRow \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--rowId <ROW_ID>
4 changes: 4 additions & 0 deletions docs/examples/tablesdb/delete-rows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
appwrite tablesDB deleteRows \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \

3 changes: 3 additions & 0 deletions docs/examples/tablesdb/delete-table.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
appwrite tablesDB deleteTable \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID>
2 changes: 2 additions & 0 deletions docs/examples/tablesdb/delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
appwrite tablesDB delete \
--databaseId <DATABASE_ID>
4 changes: 4 additions & 0 deletions docs/examples/tablesdb/get-column.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
appwrite tablesDB getColumn \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--key ''
4 changes: 4 additions & 0 deletions docs/examples/tablesdb/get-index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
appwrite tablesDB getIndex \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--key ''
5 changes: 5 additions & 0 deletions docs/examples/tablesdb/get-row.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
appwrite tablesDB getRow \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \
--rowId <ROW_ID> \

4 changes: 4 additions & 0 deletions docs/examples/tablesdb/get-table-usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
appwrite tablesDB getTableUsage \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID> \

3 changes: 3 additions & 0 deletions docs/examples/tablesdb/get-table.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
appwrite tablesDB getTable \
--databaseId <DATABASE_ID> \
--tableId <TABLE_ID>
Loading