Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@v4
uses: actions/checkout@v6

- name: Setup Node.js
uses: actions/setup-node@v4
uses: actions/setup-node@v6
with:
node-version: "20"

Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
CLI_BUN_VERSION: '1.3.11'
HOMEBREW_TAP_REPO: appwrite/homebrew-appwrite
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
token: ${{ secrets.GH_TOKEN }}
- uses: oven-sh/setup-bun@v2
Expand Down Expand Up @@ -50,7 +50,7 @@ jobs:
bun run windows-arm64

- name: Setup Node.js
uses: actions/setup-node@v4
uses: actions/setup-node@v6
with:
node-version: '24.14.1'
registry-url: 'https://registry.npmjs.org'
Expand All @@ -77,7 +77,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}

- name: Check out Homebrew tap
uses: actions/checkout@v4
uses: actions/checkout@v6
with:
repository: ${{ env.HOMEBREW_TAP_REPO }}
token: ${{ secrets.HOMEBREW_TAP_GH_TOKEN }}
Expand Down
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# Change Log

## 20.0.0

* Breaking: Removed `projects delete`. Use `project delete` instead
* Breaking: Replaced `projects update-mock-numbers` with `project create-mock-phone`, `list-mock-phones`, `get-mock-phone`, `update-mock-phone`, and `delete-mock-phone`
* Breaking: Renamed `projects update-auth-status` to `project update-auth-method` with `--method-id` and `--enabled` flags
* Breaking: Replaced `projects update-o-auth-2` with per-provider `project update-o-auth-2-<provider>` commands
* Breaking: Replaced `projects create-jwt` with `project create-ephemeral-key` for short-lived API keys
* Added `project list-o-auth-2-providers`, `get-o-auth-2-provider`, `list-policies`, `get-policy`, and `list-email-templates` commands
* Added `fusionauth`, `keycloak`, and `kick` to supported OAuth2 providers in `account` session commands
* Added `includes` field in `appwrite.config.json` to split resource arrays into separate JSON files; `init`, `pull`, and `push` resolve resource paths relative to each include

## 19.2.0

* Added `completion install` command with completion scripts for zsh, bash, and fish
Expand Down
45 changes: 42 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 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.9.2-blue.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.9.3-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)
Expand Down Expand Up @@ -29,7 +29,7 @@ Once the installation is complete, you can verify the install using

```sh
$ appwrite -v
19.2.0
20.0.0
```

### Install using prebuilt binaries
Expand Down Expand Up @@ -83,7 +83,7 @@ $ scoop install https://raw.githubusercontent.com/appwrite/sdk-for-cli/master/sc
Once the installation completes, you can verify your install using
```
$ appwrite -v
19.2.0
20.0.0
```

## Getting Started
Expand Down Expand Up @@ -231,6 +231,45 @@ appwrite client --endpoint http://localhost/v1 --projectId <PROJECT_ID> --key <A
```


## Project configuration

The CLI reads project resources from `appwrite.config.json`. Large resource arrays can be split into smaller JSON files with `includes`:

```json
{
"projectId": "my-project",
"includes": {
"functions": "./appwrite/functions.json",
"sites": "./appwrite/sites.json",
"databases": "./appwrite/databases.json",
"collections": "./appwrite/collections.json",
"tablesDB": "./appwrite/tables-db.json",
"tables": "./appwrite/tables.json",
"buckets": "./appwrite/buckets.json",
"teams": "./appwrite/teams.json",
"webhooks": "./appwrite/webhooks.json",
"topics": "./appwrite/topics.json",
"messages": "./appwrite/messages.json"
}
}
```

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:

```json
[
{
"$id": "api",
"name": "API",
"runtime": "node-22",
"path": "functions/api",
"entrypoint": "src/main.ts"
}
]
```

JSON pointer fragments such as `./resources.json#/functions` are not supported.

## Contribution

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.
Expand Down
Loading