appwrite-cli 19.2.0 → 20.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +42 -3
- package/dist/bundle-win-arm64.mjs +4392 -1303
- package/dist/cli.cjs +4392 -1303
- package/dist/index.cjs +3830 -1099
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3830 -1099
- package/dist/lib/commands/config.d.ts +26 -12
- package/dist/lib/commands/config.d.ts.map +1 -1
- package/dist/lib/commands/init.d.ts.map +1 -1
- package/dist/lib/commands/pull.d.ts +4 -0
- package/dist/lib/commands/pull.d.ts.map +1 -1
- package/dist/lib/commands/push.d.ts.map +1 -1
- package/dist/lib/commands/run.d.ts.map +1 -1
- package/dist/lib/commands/schema.d.ts +3 -1
- package/dist/lib/commands/schema.d.ts.map +1 -1
- package/dist/lib/commands/services/account.d.ts.map +1 -1
- package/dist/lib/commands/services/databases.d.ts.map +1 -1
- package/dist/lib/commands/services/functions.d.ts.map +1 -1
- package/dist/lib/commands/services/graphql.d.ts.map +1 -1
- package/dist/lib/commands/services/messaging.d.ts.map +1 -1
- package/dist/lib/commands/services/projects.d.ts.map +1 -1
- package/dist/lib/commands/services/tables-db.d.ts.map +1 -1
- package/dist/lib/commands/services/teams.d.ts.map +1 -1
- package/dist/lib/commands/services/users.d.ts.map +1 -1
- package/dist/lib/config.d.ts +15 -1
- package/dist/lib/config.d.ts.map +1 -1
- package/dist/lib/constants.d.ts +1 -1
- package/dist/lib/emulation/docker.d.ts.map +1 -1
- package/dist/lib/emulation/utils.d.ts.map +1 -1
- package/dist/lib/parser.d.ts +1 -0
- package/dist/lib/parser.d.ts.map +1 -1
- package/dist/lib/utils.d.ts.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Appwrite Command Line SDK
|
|
2
2
|
|
|
3
3
|
|
|
4
|
-
|
|
5
5
|
[](https://travis-ci.com/appwrite/sdk-generator)
|
|
6
6
|
[](https://twitter.com/appwrite)
|
|
7
7
|
[](https://appwrite.io/discord)
|
|
@@ -29,7 +29,7 @@ Once the installation is complete, you can verify the install using
|
|
|
29
29
|
|
|
30
30
|
```sh
|
|
31
31
|
$ appwrite -v
|
|
32
|
-
|
|
32
|
+
20.0.0
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
### Install using prebuilt binaries
|
|
@@ -83,7 +83,7 @@ $ scoop install https://raw.githubusercontent.com/appwrite/sdk-for-cli/master/sc
|
|
|
83
83
|
Once the installation completes, you can verify your install using
|
|
84
84
|
```
|
|
85
85
|
$ appwrite -v
|
|
86
|
-
|
|
86
|
+
20.0.0
|
|
87
87
|
```
|
|
88
88
|
|
|
89
89
|
## Getting Started
|
|
@@ -231,6 +231,45 @@ appwrite client --endpoint http://localhost/v1 --projectId <PROJECT_ID> --key <A
|
|
|
231
231
|
```
|
|
232
232
|
|
|
233
233
|
|
|
234
|
+
## Project configuration
|
|
235
|
+
|
|
236
|
+
The CLI reads project resources from `appwrite.config.json`. Large resource arrays can be split into smaller JSON files with `includes`:
|
|
237
|
+
|
|
238
|
+
```json
|
|
239
|
+
{
|
|
240
|
+
"projectId": "my-project",
|
|
241
|
+
"includes": {
|
|
242
|
+
"functions": "./appwrite/functions.json",
|
|
243
|
+
"sites": "./appwrite/sites.json",
|
|
244
|
+
"databases": "./appwrite/databases.json",
|
|
245
|
+
"collections": "./appwrite/collections.json",
|
|
246
|
+
"tablesDB": "./appwrite/tables-db.json",
|
|
247
|
+
"tables": "./appwrite/tables.json",
|
|
248
|
+
"buckets": "./appwrite/buckets.json",
|
|
249
|
+
"teams": "./appwrite/teams.json",
|
|
250
|
+
"webhooks": "./appwrite/webhooks.json",
|
|
251
|
+
"topics": "./appwrite/topics.json",
|
|
252
|
+
"messages": "./appwrite/messages.json"
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
Each included file contains only the array for that resource. Include paths are resolved relative to `appwrite.config.json`, and resource-local paths inside an included file are resolved relative to that included file:
|
|
258
|
+
|
|
259
|
+
```json
|
|
260
|
+
[
|
|
261
|
+
{
|
|
262
|
+
"$id": "api",
|
|
263
|
+
"name": "API",
|
|
264
|
+
"runtime": "node-22",
|
|
265
|
+
"path": "functions/api",
|
|
266
|
+
"entrypoint": "src/main.ts"
|
|
267
|
+
}
|
|
268
|
+
]
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
JSON pointer fragments such as `./resources.json#/functions` are not supported.
|
|
272
|
+
|
|
234
273
|
## Contribution
|
|
235
274
|
|
|
236
275
|
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.
|