You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Fix optional attributes using `?` instead of `| null`
8
+
* Fix `Models` import error
9
+
* Improve formatting and add auto-generated comments
10
+
11
+
## 8.1.0
12
+
13
+
* Add multi-region support to `init` command
14
+
* Update `init` command to clear previous configuration in `appwrite.json`
15
+
* Update localConfig to store multi-region endpoint
16
+
* Fix throw error when creating unknown attribute instead of timing out
17
+
* Fix equal comparison of large numbers and BigNumber instances using proper equality checks
18
+
* Fix duplication of reasons when comparing localConfig with remoteConfig
19
+
* Fix `firstOrNull()` to `firstOrNull` in types generation for dart
20
+
* Refactor to use `isCloud()` method consistently
21
+
22
+
## 8.0.2
23
+
24
+
* Add Type generation fixes:
25
+
* Properly handle enum attributes in dart, java and kotlin
26
+
* Fix initialisation of null attributes in dart's fromMap method
27
+
* Fix relationships and enums in swift
28
+
29
+
## 8.0.1
30
+
31
+
* Add `resourceId` and `resourceType` attributes to `createRedirectRule`
32
+
* Add `providerReference` to vcs command for getting repository contents
33
+
* Add warning comment to `bulk updateDocuments` method
34
+
* Fix type generation for enums in Typescript and PHP language
35
+
36
+
## 8.0.0
37
+
38
+
* Add `types` command to generate language specific typings for collections. Currently supports - `php`, `swift`, `dart`, `js`, `ts`, `kotlin` and `java`
39
+
* Update bulk operation docs to include experiment feature warnings
40
+
* Remove assistant service and commands
41
+
42
+
## 7.0.0
43
+
44
+
* Add `sites` command
45
+
* Add `tokens` command
46
+
* Add `devKeys` support to `projects` command
47
+
* Add `init site`, `pull site` and `push site` commands
48
+
* Add bulk operation methods like `createDocuments`, `deleteDocuments` etc.
49
+
* Add new upsert methods: `upsertDocument` and `upsertDocuments`
50
+
* Update GET requests to not include content-type header
51
+
52
+
## 6.2.3
53
+
54
+
* Fix hot swapping error in `python-ml` function
55
+
56
+
## 6.2.2
57
+
58
+
* Fix GitHub builds by adding `qemu-system` package
59
+
* Fix attribute creation timed out
60
+
61
+
## 6.2.1
62
+
63
+
* Add `listOrganizations` method to `organizations` service and fix init project command
64
+
65
+
## 6.2.0
66
+
67
+
* Add specifications support to CLI
68
+
* Update package version
69
+
* Fix: Missed specifications param when updating a function
Copyright (c) 2022 Appwrite (https://appwrite.io) and individual contributors.
1
+
Copyright (c) 2025 Appwrite (https://appwrite.io) and individual contributors.
2
2
All rights reserved.
3
3
4
4
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
@@ -7,6 +7,6 @@ Redistribution and use in source and binary forms, with or without modification,
7
7
8
8
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.
9
9
10
-
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.
10
+
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
11
11
12
-
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.
12
+
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.
**This SDK is compatible with Appwrite server version 0.13.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-cli/releases).**
9
+
**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).**
10
10
11
11
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)
This will also prompt you to enter your Appwrite endpoint ( default: http://localhost/v1 )
78
+
79
+
*### Initialising your project
80
+
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.
81
+
82
+
```sh
83
+
$ appwrite init project
84
+
```
85
+
86
+
The following prompt will guide you through the setup process. The `init` command also creates an `appwrite.json` file representing your Appwrite project.
87
+
88
+
The `appwrite.json` file does a lot of things.
89
+
* Provides context to the CLI
90
+
* Keeps track of all your cloud functions
91
+
* Keeps track of all your project's collections
92
+
* Helps you deploy your Appwrite project to production and more..
93
+
94
+
You can also fetch all the collections in your current project using
95
+
```sh
96
+
appwrite init collection
97
+
```
98
+
99
+
*### Creating and deploying cloud functions
100
+
101
+
The CLI makes it extremely easy to create and deploy Appwrite's cloud functions. Initialise your new function using
102
+
103
+
```
104
+
$ appwrite init function
105
+
? What would you like to name your function? My Awesome Function
106
+
? What runtime would you like to use? Node.js (node-15.5)
107
+
✓ Success
108
+
```
109
+
110
+
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.
111
+
112
+
```sh
113
+
$ tree My\ Awesome\ Function
114
+
115
+
My Awesome Function
116
+
├── README.md
117
+
├── index.js
118
+
├── package-lock.json
119
+
└── package.json
120
+
121
+
0 directories, 4 files
122
+
```
123
+
124
+
You can now deploy this function using
125
+
126
+
```sh
127
+
$ appwrite push function
128
+
129
+
? Which functions would you like to deploy? My Awesome Function (61d1a4c81dfcd95bc834)
130
+
ℹ Info Deploying functionMy Awesome Function ( 61d1a4c81dfcd95bc834 )
131
+
✓ Success Deployed My Awesome Function ( 61d1a4c81dfcd95bc834 )
132
+
```
133
+
134
+
Your function has now been deployed on your Appwrite server! As soon as the build process is finished, you can start executing the function.
135
+
136
+
*### Deploying Collections
137
+
138
+
Similarly, you can deploy all your collections to your Appwrite server using
139
+
140
+
```sh
141
+
appwrite push collections
142
+
```
143
+
144
+
> ### Note
145
+
> 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
146
+
```sh
147
+
$ appwrite client --selfSigned true
148
+
```
149
+
150
+
## Usage
151
+
152
+
The Appwrite CLI follows the following general syntax.
-`data` must be a valid JSON string where each key and value are enclosed in double quotes `"` like the example above.
171
+
- 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.
172
+
173
+
174
+
To get information about the different services available, you can use
175
+
```sh
176
+
$ appwrite -h
177
+
```
178
+
179
+
To get information about a particular service and the commands available in a service you can use
180
+
```sh
181
+
$ appwrite users // or
182
+
$ appwrite users --help // or
183
+
$ appwrite users help // or
184
+
$ appwrite accounts
185
+
```
186
+
187
+
To get information about a particular command and the parameters it accepts, you can use
188
+
189
+
```sh
190
+
$ appwrite users list --help
191
+
$ appwrite account get --help
192
+
```
193
+
194
+
At any point, you can view or reset the CLI configuration using the `client` service.
195
+
196
+
```
197
+
$ appwrite client --debug
198
+
// This will display your endpoint, projectID, API key and so on.
199
+
$ appwrite client --reset
200
+
```
201
+
202
+
## CI mode
203
+
204
+
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
0 commit comments