npx skills add https://github.com/appwrite/agent-skills --skill appwrite-cli# npm
npm install -g appwrite-cli
# macOS (Homebrew)
brew install appwrite
# macOS / Linux (script)
curl -sL https://appwrite.io/cli/install.sh | bash
# Windows (Scoop)
scoop install https://raw.githubusercontent.com/appwrite/sdk-for-cli/master/scoop/appwrite.config.json
验证安装:
appwrite -v
# 登录到您的账户
appwrite login
# 登录到自托管实例
appwrite login --endpoint "https://your-instance.com/v1"
# 初始化项目(创建 appwrite.config.json)
appwrite init project
# 通过获取项目信息进行验证
appwrite projects get --project-id "<PROJECT_ID>"
# 使用 Appwrite 进行身份验证
appwrite login
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
所有资源配置在项目根目录下的单个 appwrite.config.json 文件中:
{
"projectId": "<PROJECT_ID>",
"endpoint": "https://<REGION>.cloud.appwrite.io/v1",
"functions": [],
"sites": [],
"tablesDB": [],
"tables": [],
"buckets": [],
"teams": [],
"topics": []
}
# 创建新函数
appwrite init functions
# 从控制台拉取现有函数
appwrite pull functions
# 部署函数
appwrite push functions
{
"functions": [
{
"$id": "<FUNCTION_ID>",
"name": "userAuth",
"enabled": true,
"live": true,
"logging": true,
"runtime": "node-18.0",
"deployment": "<DEPLOYMENT_ID>",
"vars": [],
"events": [],
"schedule": "",
"timeout": 15,
"entrypoint": "userAuth.js",
"commands": "npm install",
"version": "v3",
"path": "functions/userAuth"
}
]
}
| 命令 | 描述 |
|---|---|
appwrite functions list | 列出所有函数 |
appwrite functions create | 创建新函数 |
appwrite functions get --function-id <ID> | 通过 ID 获取函数 |
appwrite functions update --function-id <ID> | 更新函数 |
appwrite functions delete --function-id <ID> | 删除函数 |
appwrite functions list-runtimes | 列出所有活跃的运行时 |
appwrite functions list-deployments --function-id <ID> | 列出部署 |
appwrite functions create-deployment --function-id <ID> | 上传新部署 |
appwrite functions update-deployment --function-id <ID> --deployment-id <ID> | 设置活跃部署 |
appwrite functions delete-deployment --function-id <ID> --deployment-id <ID> | 删除部署 |
appwrite functions download-deployment --function-id <ID> --deployment-id <ID> | 下载部署 |
appwrite functions create-execution --function-id <ID> | 触发执行 |
appwrite functions list-executions --function-id <ID> | 列出执行日志 |
appwrite functions get-execution --function-id <ID> --execution-id <ID> | 获取执行日志 |
appwrite functions list-variables --function-id <ID> | 列出变量 |
appwrite functions create-variable --function-id <ID> --key <KEY> --value <VALUE> | 创建变量 |
appwrite functions update-variable --function-id <ID> --variable-id <ID> --key <KEY> --value <VALUE> | 更新变量 |
appwrite functions delete-variable --function-id <ID> --variable-id <ID> | 删除变量 |
appwrite functions create-execution \
--function-id <FUNCTION_ID> \
--body '{"key": "value"}'
appwrite run functions
# 创建新站点
appwrite init sites
# 从控制台拉取现有站点
appwrite pull sites
# 部署站点
appwrite push sites
{
"sites": [
{
"$id": "<SITE_ID>",
"name": "Documentation template",
"enabled": true,
"logging": true,
"framework": "astro",
"timeout": 30,
"installCommand": "npm install",
"buildCommand": "npm run build",
"outputDirectory": "./dist",
"specification": "s-1vcpu-512mb",
"buildRuntime": "node-22",
"adapter": "ssr",
"fallbackFile": "",
"path": "sites/documentation-template"
}
]
}
| 命令 | 描述 |
|---|---|
appwrite sites list | 列出所有站点 |
appwrite sites create | 创建新站点 |
appwrite sites get --site-id <ID> | 通过 ID 获取站点 |
appwrite sites update --site-id <ID> | 更新站点 |
appwrite sites delete --site-id <ID> | 删除站点 |
appwrite sites list-frameworks | 列出可用框架 |
appwrite sites list-specifications | 列出允许的规格 |
appwrite sites list-templates | 列出可用模板 |
appwrite sites get-template --template-id <ID> | 获取模板详情 |
appwrite sites list-deployments --site-id <ID> | 列出部署 |
appwrite sites create-deployment --site-id <ID> | 创建部署 |
appwrite sites get-deployment --site-id <ID> --deployment-id <ID> | 获取部署 |
appwrite sites delete-deployment --site-id <ID> --deployment-id <ID> | 删除部署 |
appwrite sites update-site-deployment --site-id <ID> --deployment-id <ID> | 设置活跃部署 |
appwrite sites update-deployment-status --site-id <ID> --deployment-id <ID> | 取消正在进行的构建 |
appwrite sites list-variables --site-id <ID> | 列出变量 |
appwrite sites create-variable --site-id <ID> --key <KEY> --value <VALUE> | 创建变量 |
appwrite sites update-variable --site-id <ID> --variable-id <ID> --key <KEY> --value <VALUE> | 更新变量 |
appwrite sites delete-variable --site-id <ID> --variable-id <ID> | 删除变量 |
appwrite sites list-logs --site-id <ID> | 列出请求日志 |
appwrite sites get-log --site-id <ID> --log-id <ID> | 获取日志 |
appwrite sites delete-log --site-id <ID> --log-id <ID> | 删除日志 |
# 创建新表
appwrite init tables
# 从控制台拉取现有表
appwrite pull tables
# 部署表
appwrite push tables
{
"tablesDB": [
{
"$id": "<DATABASE_ID>",
"name": "songs",
"enabled": true
}
],
"tables": [
{
"$id": "<TABLE_ID>",
"$permissions": ["create(\"any\")", "read(\"any\")"],
"databaseId": "<DATABASE_ID>",
"name": "music",
"enabled": true,
"rowSecurity": false,
"columns": [
{
"key": "title",
"type": "varchar",
"required": true,
"size": 255
}
],
"indexes": []
}
]
}
| 命令 | 描述 |
|---|---|
appwrite tables-db list-tables --database-id <ID> | 列出表 |
appwrite tables-db create-table --database-id <ID> | 创建表 |
appwrite tables-db get-table --database-id <ID> --table-id <ID> | 获取表 |
appwrite tables-db update-table --database-id <ID> --table-id <ID> | 更新表 |
appwrite tables-db delete-table --database-id <ID> --table-id <ID> | 删除表 |
appwrite tables-db list-columns --database-id <ID> --table-id <ID> | 列出列 |
appwrite tables-db get-column --database-id <ID> --table-id <ID> --key <KEY> | 获取列 |
appwrite tables-db delete-column --database-id <ID> --table-id <ID> --key <KEY> | 删除列 |
appwrite tables-db list-column-indexes --database-id <ID> --table-id <ID> | 列出索引 |
appwrite tables-db create-column-index --database-id <ID> --table-id <ID> | 创建索引 |
appwrite tables-db delete-column-index --database-id <ID> --table-id <ID> --key <KEY> | 删除索引 |
注意: 已弃用旧的
string类型。请改用明确的字符串列类型。
| 命令 | 描述 |
|---|---|
create-varchar-column | Varchar 列 — 内联存储,完全可索引(最大 16,383 字符,大小 ≤ 768 用于完整索引) |
create-text-column | Text 列 — 页外存储,仅前缀索引(最大 16,383 字符) |
create-mediumtext-column | Mediumtext 列 — 页外存储(最大约 4M 字符) |
create-longtext-column | Longtext 列 — 页外存储(最大约 1B 字符) |
create-boolean-column | Boolean 列 |
create-integer-column | Integer 列(可选最小/最大值) |
create-float-column | Float 列(可选最小/最大值) |
create-email-column | Email 列 |
create-url-column | URL 列 |
create-ip-column | IP 地址列 |
create-datetime-column | Datetime 列 (ISO 8601) |
create-enum-column | Enum 列(接受值的白名单) |
create-relationship-column | 关系列 |
所有列命令都使用 appwrite tables-db <command> --database-id <ID> --table-id <ID>。
# 创建一行
appwrite tables-db create-row \
--database-id "<DATABASE_ID>" --table-id "<TABLE_ID>" \
--row-id 'unique()' --data '{ "title": "Hello World" }' \
--permissions 'read("any")' 'write("team:abc")'
# 列出行(JSON 输出)
appwrite tables-db list-rows \
--database-id "<DATABASE_ID>" --table-id "<TABLE_ID>" --json
# 获取一行
appwrite tables-db get-row \
--database-id "<DATABASE_ID>" --table-id "<TABLE_ID>" --row-id "<ROW_ID>"
# 创建新存储桶
appwrite init buckets
# 从控制台拉取现有存储桶
appwrite pull buckets
# 部署存储桶
appwrite push buckets
| 命令 | 描述 |
|---|---|
appwrite storage list-buckets | 列出所有存储桶 |
appwrite storage create-bucket | 创建存储桶 |
appwrite storage get-bucket --bucket-id <ID> | 获取存储桶 |
appwrite storage update-bucket --bucket-id <ID> | 更新存储桶 |
appwrite storage delete-bucket --bucket-id <ID> | 删除存储桶 |
appwrite storage list-files --bucket-id <ID> | 列出文件 |
appwrite storage create-file --bucket-id <ID> | 上传文件 |
appwrite storage get-file --bucket-id <ID> --file-id <ID> | 获取文件元数据 |
appwrite storage delete-file --bucket-id <ID> --file-id <ID> | 删除文件 |
appwrite storage get-file-download --bucket-id <ID> --file-id <ID> | 下载文件 |
appwrite storage get-file-preview --bucket-id <ID> --file-id <ID> | 获取图片预览 |
appwrite storage get-file-view --bucket-id <ID> --file-id <ID> | 在浏览器中查看文件 |
# 创建新团队
appwrite init teams
# 从控制台拉取现有团队
appwrite pull teams
# 部署团队
appwrite push teams
| 命令 | 描述 |
|---|---|
appwrite teams list | 列出所有团队 |
appwrite teams create | 创建团队 |
appwrite teams get --team-id <ID> | 获取团队 |
appwrite teams update-name --team-id <ID> | 更新团队名称 |
appwrite teams delete --team-id <ID> | 删除团队 |
appwrite teams list-memberships --team-id <ID> | 列出成员 |
appwrite teams create-membership --team-id <ID> | 邀请成员 |
appwrite teams update-membership --team-id <ID> --membership-id <ID> | 更新成员角色 |
appwrite teams delete-membership --team-id <ID> --membership-id <ID> | 移除成员 |
appwrite teams get-prefs --team-id <ID> | 获取团队偏好设置 |
appwrite teams update-prefs --team-id <ID> | 更新团队偏好设置 |
# 创建新主题
appwrite init topics
# 从控制台拉取现有主题
appwrite pull topics
# 部署主题
appwrite push topics
| 命令 | 描述 |
|---|---|
appwrite messaging list-messages | 列出所有消息 |
appwrite messaging create-email | 创建电子邮件消息 |
appwrite messaging create-push | 创建推送通知 |
appwrite messaging create-sms | 创建短信消息 |
appwrite messaging get-message --message-id <ID> | 获取消息 |
appwrite messaging delete --message-id <ID> | 删除消息 |
appwrite messaging list-topics | 列出所有主题 |
appwrite messaging create-topic | 创建主题 |
appwrite messaging get-topic --topic-id <ID> | 获取主题 |
appwrite messaging update-topic --topic-id <ID> | 更新主题 |
appwrite messaging delete-topic --topic-id <ID> | 删除主题 |
appwrite messaging list-subscribers --topic-id <ID> | 列出订阅者 |
appwrite messaging create-subscriber --topic-id <ID> | 添加订阅者 |
appwrite messaging delete-subscriber --topic-id <ID> --subscriber-id <ID> | 移除订阅者 |
# 创建用户
appwrite users create --user-id "unique()" \
--email hello@appwrite.io
# 列出用户
appwrite users list
# 获取用户
appwrite users get --user-id "<USER_ID>"
# 删除用户
appwrite users delete --user-id "<USER_ID>"
# 自动检测语言并生成
appwrite generate
# 指定输出目录
appwrite generate --output ./src/generated
# 指定语言
appwrite generate --language typescript
生成的文件:
| 文件 | 描述 |
|---|---|
types.ts | 来自数据库架构的类型定义 |
databases.ts | 用于查询和修改行的类型化数据库助手 |
constants.ts | 配置常量(端点、项目 ID) |
index.ts | 导出所有助手的入口点 |
用法:
import { databases } from "./generated/appwrite";
const customers = databases.use("main").use("customers");
// 创建
const customer = await customers.create({
name: "Walter O' Brian",
email: "walter@example.com"
});
// 使用类型化查询列出
const results = await customers.list({
queries: (q) => [
q.equal("name", "Walter O' Brian"),
q.orderDesc("$createdAt"),
q.limit(10)
]
});
// 更新
await customers.update("customer-id-123", {
email: "walter@scorpion.com"
});
// 删除
await customers.delete("customer-id-123");
// 批量创建
await customers.createMany([
{ name: "Walter O' Brian", email: "walter@example.com" },
{ name: "Paige Dineen", email: "paige@example.com" }
]);
关于无头自动化,请参阅 非交互模式文档。
# 推送所有内容
appwrite push all --all --force
# 推送特定资源
appwrite push functions --all --force
appwrite push functions --function-id <FUNCTION_ID> --force
appwrite push sites --all --force
appwrite push tables --all --force
appwrite push teams --all --force
appwrite push buckets --all --force
appwrite push topics --all --force
| 选项 | 描述 |
|---|---|
-v, --version | 输出版本号 |
-V, --verbose | 显示完整错误日志 |
-j, --json | 以 JSON 格式输出 |
-f, --force | 确认所有警告 |
-a, --all | 选择所有资源 |
--id [id...] | 传递 ID 列表 |
--report | 生成 GitHub 错误报告链接 |
--console | 获取控制台的直接链接 |
--open | 在浏览器中打开控制台链接 |
-h, --help | 显示帮助 |
# 以 JSON 输出列出用户
appwrite users list --json
# 获取详细错误输出
appwrite users list --verbose
# 在控制台中查看一行
appwrite tables-db get-row \
--database-id "<DATABASE_ID>" \
--table-id "<TABLE_ID>" \
--row-id "<ROW_ID>" \
--console --open
# 生成错误报告
appwrite login --report
每周安装量
27
仓库
GitHub 星标数
6
首次出现
9 天前
安全审计
安装于
opencode27
codex27
gemini-cli26
github-copilot26
amp26
cline26
# npm
npm install -g appwrite-cli
# macOS (Homebrew)
brew install appwrite
# macOS / Linux (script)
curl -sL https://appwrite.io/cli/install.sh | bash
# Windows (Scoop)
scoop install https://raw.githubusercontent.com/appwrite/sdk-for-cli/master/scoop/appwrite.config.json
Verify installation:
appwrite -v
# Login to your account
appwrite login
# Login to a self-hosted instance
appwrite login --endpoint "https://your-instance.com/v1"
# Initialize a project (creates appwrite.config.json)
appwrite init project
# Verify by fetching project info
appwrite projects get --project-id "<PROJECT_ID>"
# Authenticate with Appwrite
appwrite login
For the full list of CLI commands, see CLI Commands. For headless / CI/CD usage, see Non-Interactive Mode.
All resources are configured in a single appwrite.config.json file at the project root:
{
"projectId": "<PROJECT_ID>",
"endpoint": "https://<REGION>.cloud.appwrite.io/v1",
"functions": [],
"sites": [],
"tablesDB": [],
"tables": [],
"buckets": [],
"teams": [],
"topics": []
}
# Create a new function
appwrite init functions
# Pull existing functions from Console
appwrite pull functions
# Deploy functions
appwrite push functions
{
"functions": [
{
"$id": "<FUNCTION_ID>",
"name": "userAuth",
"enabled": true,
"live": true,
"logging": true,
"runtime": "node-18.0",
"deployment": "<DEPLOYMENT_ID>",
"vars": [],
"events": [],
"schedule": "",
"timeout": 15,
"entrypoint": "userAuth.js",
"commands": "npm install",
"version": "v3",
"path": "functions/userAuth"
}
]
}
| Command | Description |
|---|---|
appwrite functions list | List all functions |
appwrite functions create | Create a new function |
appwrite functions get --function-id <ID> | Get a function by ID |
appwrite functions update --function-id <ID> | Update a function |
appwrite functions delete --function-id <ID> | Delete a function |
appwrite functions list-runtimes |
appwrite functions create-execution \
--function-id <FUNCTION_ID> \
--body '{"key": "value"}'
appwrite run functions
# Create a new site
appwrite init sites
# Pull existing sites from Console
appwrite pull sites
# Deploy sites
appwrite push sites
{
"sites": [
{
"$id": "<SITE_ID>",
"name": "Documentation template",
"enabled": true,
"logging": true,
"framework": "astro",
"timeout": 30,
"installCommand": "npm install",
"buildCommand": "npm run build",
"outputDirectory": "./dist",
"specification": "s-1vcpu-512mb",
"buildRuntime": "node-22",
"adapter": "ssr",
"fallbackFile": "",
"path": "sites/documentation-template"
}
]
}
| Command | Description |
|---|---|
appwrite sites list | List all sites |
appwrite sites create | Create a new site |
appwrite sites get --site-id <ID> | Get a site by ID |
appwrite sites update --site-id <ID> | Update a site |
appwrite sites delete --site-id <ID> | Delete a site |
appwrite sites list-frameworks |
# Create a new table
appwrite init tables
# Pull existing tables from Console
appwrite pull tables
# Deploy tables
appwrite push tables
{
"tablesDB": [
{
"$id": "<DATABASE_ID>",
"name": "songs",
"enabled": true
}
],
"tables": [
{
"$id": "<TABLE_ID>",
"$permissions": ["create(\"any\")", "read(\"any\")"],
"databaseId": "<DATABASE_ID>",
"name": "music",
"enabled": true,
"rowSecurity": false,
"columns": [
{
"key": "title",
"type": "varchar",
"required": true,
"size": 255
}
],
"indexes": []
}
]
}
| Command | Description |
|---|---|
appwrite tables-db list-tables --database-id <ID> | List tables |
appwrite tables-db create-table --database-id <ID> | Create table |
appwrite tables-db get-table --database-id <ID> --table-id <ID> | Get table |
appwrite tables-db update-table --database-id <ID> --table-id <ID> | Update table |
appwrite tables-db delete-table --database-id <ID> --table-id <ID> | Delete table |
Note: The legacy
stringtype is deprecated. Use explicit string column types instead.
| Command | Description |
|---|---|
create-varchar-column | Varchar column — inline storage, fully indexable (max 16,383 chars, size ≤ 768 for full index) |
create-text-column | Text column — off-page storage, prefix index only (max 16,383 chars) |
create-mediumtext-column | Mediumtext column — off-page storage (max ~4M chars) |
create-longtext-column | Longtext column — off-page storage (max ~1B chars) |
create-boolean-column | Boolean column |
create-integer-column |
All column commands use appwrite tables-db <command> --database-id <ID> --table-id <ID>.
# Create a row
appwrite tables-db create-row \
--database-id "<DATABASE_ID>" --table-id "<TABLE_ID>" \
--row-id 'unique()' --data '{ "title": "Hello World" }' \
--permissions 'read("any")' 'write("team:abc")'
# List rows (JSON output)
appwrite tables-db list-rows \
--database-id "<DATABASE_ID>" --table-id "<TABLE_ID>" --json
# Get a row
appwrite tables-db get-row \
--database-id "<DATABASE_ID>" --table-id "<TABLE_ID>" --row-id "<ROW_ID>"
# Create a new bucket
appwrite init buckets
# Pull existing buckets from Console
appwrite pull buckets
# Deploy buckets
appwrite push buckets
| Command | Description |
|---|---|
appwrite storage list-buckets | List all buckets |
appwrite storage create-bucket | Create a bucket |
appwrite storage get-bucket --bucket-id <ID> | Get a bucket |
appwrite storage update-bucket --bucket-id <ID> | Update a bucket |
appwrite storage delete-bucket --bucket-id <ID> | Delete a bucket |
appwrite storage list-files --bucket-id <ID> |
# Create a new team
appwrite init teams
# Pull existing teams from Console
appwrite pull teams
# Deploy teams
appwrite push teams
| Command | Description |
|---|---|
appwrite teams list | List all teams |
appwrite teams create | Create a team |
appwrite teams get --team-id <ID> | Get a team |
appwrite teams update-name --team-id <ID> | Update team name |
appwrite teams delete --team-id <ID> | Delete a team |
appwrite teams list-memberships --team-id <ID> |
# Create a new topic
appwrite init topics
# Pull existing topics from Console
appwrite pull topics
# Deploy topics
appwrite push topics
| Command | Description |
|---|---|
appwrite messaging list-messages | List all messages |
appwrite messaging create-email | Create email message |
appwrite messaging create-push | Create push notification |
appwrite messaging create-sms | Create SMS message |
appwrite messaging get-message --message-id <ID> | Get a message |
appwrite messaging delete --message-id <ID> |
# Create a user
appwrite users create --user-id "unique()" \
--email hello@appwrite.io
# List users
appwrite users list
# Get a user
appwrite users get --user-id "<USER_ID>"
# Delete a user
appwrite users delete --user-id "<USER_ID>"
# Auto-detect language and generate
appwrite generate
# Specify output directory
appwrite generate --output ./src/generated
# Specify language
appwrite generate --language typescript
Generated files:
| File | Description |
|---|---|
types.ts | Type definitions from your database schema |
databases.ts | Typed database helpers for querying and mutating rows |
constants.ts | Configuration constants (endpoint, project ID) |
index.ts | Entry point that exports all helpers |
Usage:
import { databases } from "./generated/appwrite";
const customers = databases.use("main").use("customers");
// Create
const customer = await customers.create({
name: "Walter O' Brian",
email: "walter@example.com"
});
// List with typed queries
const results = await customers.list({
queries: (q) => [
q.equal("name", "Walter O' Brian"),
q.orderDesc("$createdAt"),
q.limit(10)
]
});
// Update
await customers.update("customer-id-123", {
email: "walter@scorpion.com"
});
// Delete
await customers.delete("customer-id-123");
// Bulk create
await customers.createMany([
{ name: "Walter O' Brian", email: "walter@example.com" },
{ name: "Paige Dineen", email: "paige@example.com" }
]);
For headless automation, see the Non-Interactive Mode docs.
# Push everything
appwrite push all --all --force
# Push specific resources
appwrite push functions --all --force
appwrite push functions --function-id <FUNCTION_ID> --force
appwrite push sites --all --force
appwrite push tables --all --force
appwrite push teams --all --force
appwrite push buckets --all --force
appwrite push topics --all --force
| Option | Description |
|---|---|
-v, --version | Output version number |
-V, --verbose | Show complete error log |
-j, --json | Output in JSON format |
-f, --force | Confirm all warnings |
-a, --all | Select all resources |
--id [id...] | Pass a list of IDs |
# List users with JSON output
appwrite users list --json
# Get verbose error output
appwrite users list --verbose
# View a row in the Console
appwrite tables-db get-row \
--database-id "<DATABASE_ID>" \
--table-id "<TABLE_ID>" \
--row-id "<ROW_ID>" \
--console --open
# Generate error report
appwrite login --report
Weekly Installs
27
Repository
GitHub Stars
6
First Seen
9 days ago
Security Audits
Gen Agent Trust HubPassSocketFailSnykFail
Installed on
opencode27
codex27
gemini-cli26
github-copilot26
amp26
cline26
| List all active runtimes |
appwrite functions list-deployments --function-id <ID> | List deployments |
appwrite functions create-deployment --function-id <ID> | Upload a new deployment |
appwrite functions update-deployment --function-id <ID> --deployment-id <ID> | Set active deployment |
appwrite functions delete-deployment --function-id <ID> --deployment-id <ID> | Delete a deployment |
appwrite functions download-deployment --function-id <ID> --deployment-id <ID> | Download deployment |
appwrite functions create-execution --function-id <ID> | Trigger execution |
appwrite functions list-executions --function-id <ID> | List execution logs |
appwrite functions get-execution --function-id <ID> --execution-id <ID> | Get execution log |
appwrite functions list-variables --function-id <ID> | List variables |
appwrite functions create-variable --function-id <ID> --key <KEY> --value <VALUE> | Create variable |
appwrite functions update-variable --function-id <ID> --variable-id <ID> --key <KEY> --value <VALUE> | Update variable |
appwrite functions delete-variable --function-id <ID> --variable-id <ID> | Delete variable |
| List available frameworks |
appwrite sites list-specifications | List allowed specs |
appwrite sites list-templates | List available templates |
appwrite sites get-template --template-id <ID> | Get template details |
appwrite sites list-deployments --site-id <ID> | List deployments |
appwrite sites create-deployment --site-id <ID> | Create deployment |
appwrite sites get-deployment --site-id <ID> --deployment-id <ID> | Get deployment |
appwrite sites delete-deployment --site-id <ID> --deployment-id <ID> | Delete deployment |
appwrite sites update-site-deployment --site-id <ID> --deployment-id <ID> | Set active deployment |
appwrite sites update-deployment-status --site-id <ID> --deployment-id <ID> | Cancel ongoing build |
appwrite sites list-variables --site-id <ID> | List variables |
appwrite sites create-variable --site-id <ID> --key <KEY> --value <VALUE> | Create variable |
appwrite sites update-variable --site-id <ID> --variable-id <ID> --key <KEY> --value <VALUE> | Update variable |
appwrite sites delete-variable --site-id <ID> --variable-id <ID> | Delete variable |
appwrite sites list-logs --site-id <ID> | List request logs |
appwrite sites get-log --site-id <ID> --log-id <ID> | Get a log |
appwrite sites delete-log --site-id <ID> --log-id <ID> | Delete a log |
appwrite tables-db list-columns --database-id <ID> --table-id <ID>| List columns |
appwrite tables-db get-column --database-id <ID> --table-id <ID> --key <KEY> | Get column |
appwrite tables-db delete-column --database-id <ID> --table-id <ID> --key <KEY> | Delete column |
appwrite tables-db list-column-indexes --database-id <ID> --table-id <ID> | List indexes |
appwrite tables-db create-column-index --database-id <ID> --table-id <ID> | Create index |
appwrite tables-db delete-column-index --database-id <ID> --table-id <ID> --key <KEY> | Delete index |
| Integer column (optional min/max) |
create-float-column | Float column (optional min/max) |
create-email-column | Email column |
create-url-column | URL column |
create-ip-column | IP address column |
create-datetime-column | Datetime column (ISO 8601) |
create-enum-column | Enum column (whitelist of accepted values) |
create-relationship-column | Relationship column |
| List files |
appwrite storage create-file --bucket-id <ID> | Upload a file |
appwrite storage get-file --bucket-id <ID> --file-id <ID> | Get file metadata |
appwrite storage delete-file --bucket-id <ID> --file-id <ID> | Delete a file |
appwrite storage get-file-download --bucket-id <ID> --file-id <ID> | Download a file |
appwrite storage get-file-preview --bucket-id <ID> --file-id <ID> | Get image preview |
appwrite storage get-file-view --bucket-id <ID> --file-id <ID> | View file in browser |
| List members |
appwrite teams create-membership --team-id <ID> | Invite a member |
appwrite teams update-membership --team-id <ID> --membership-id <ID> | Update member roles |
appwrite teams delete-membership --team-id <ID> --membership-id <ID> | Remove a member |
appwrite teams get-prefs --team-id <ID> | Get team preferences |
appwrite teams update-prefs --team-id <ID> | Update team preferences |
| Delete a message |
appwrite messaging list-topics | List all topics |
appwrite messaging create-topic | Create a topic |
appwrite messaging get-topic --topic-id <ID> | Get a topic |
appwrite messaging update-topic --topic-id <ID> | Update a topic |
appwrite messaging delete-topic --topic-id <ID> | Delete a topic |
appwrite messaging list-subscribers --topic-id <ID> | List subscribers |
appwrite messaging create-subscriber --topic-id <ID> | Add subscriber |
appwrite messaging delete-subscriber --topic-id <ID> --subscriber-id <ID> | Remove subscriber |
--report | Generate GitHub error report link |
--console | Get direct link to Console |
--open | Open Console link in browser |
-h, --help | Display help |