# 应用程序写入 CLI ## 安装 # npm npm 安装-g appwrite-cli # macOS（自制）酿造安装应用程序写入 # macOS / Linux（脚本）卷曲-sL https://appwrite.io/cli/install.sh |巴什 # Windows（独家报道）勺子安装 https://raw.githubusercontent.com/appwrite/sdk-for-cli/master/scoop/appwrite.config.json 验证安装：应用程序写入-v ## 登录和初始化 # 登录您的帐户应用程序写入登录 # 登录自托管实例 appwrite登录--端点“https://your-instance.com/v1” # 初始化项目（创建appwrite.config.json） appwrite初始化项目 # 通过获取项目信息进行验证 appwrite 项目获取 --project-id "" ## 配置 appwrite 客户端 --endpoint https://.cloud.appwrite.io/v1 appwrite 客户端 --key appwrite client --self-signed true # 用于自签名 SSL 证书 appwrite client --reset # 重置 CLI 配置 appwrite client --debug # 打印当前配置 ## appwrite.config.json 所有资源都在项目根目录下的单个“appwrite.config.json”文件中配置： { "projectId": "", “端点”：“https://.cloud.appwrite.io/v1”， “功能”：[]， “站点”：[]， “表数据库”：[]， “表”：[]， “桶”：[]， “团队”：[]， “主题”：[] } ## 部署函数 # 创建一个新函数 appwrite初始化函数 # 从控制台拉取现有函数 appwrite 拉取函数 # 部署函数 appwrite推送功能 ### appwrite.config.json 中的函数配置 { “功能”：[ { "$id": "", “名称”：“用户验证”， “启用”：正确， “活”：真实， “记录”：真实， “运行时”：“节点-18.0”， “部署”：“”， “变量”：[]， “事件”：[]， “时间表”：“”， “超时”：15， “入口点”：“userAuth.js”， “命令”：“npm 安装”， “版本”：“v3”， “路径”：“功能/用户验证” } ] } ### 功能命令命令 |描述 ---|--- `appwrite 函数列表` |列出所有函数 `appwrite 函数创建` |创建一个新函数 `appwrite 函数 get --function-id ` |通过ID获取函数 `appwrite 函数更新 --function-id ` |更新一个功能 `appwrite 函数删除 --function-id ` |删除函数 `appwrite 函数列表运行时` |列出所有活动运行时 `appwrite 函数列表部署 --function-id ` |列出部署 `appwrite 函数创建部署 --function-id ` |上传新部署 `appwrite 函数更新部署 --function-id --deployment-id ` |设置活动部署 `appwrite 函数删除部署 --function-id --deployment-id ` |删除部署 `appwrite 函数下载部署 --function-id --deployment-id ` |下载部署 `appwrite 函数创建执行 --function-id ` |触发执行 `appwrite 函数列表执行 --function-id ` |列出执行日志 `appwrite 函数 get-execution --function-id --execution-id ` |获取执行日志 `appwrite 函数列表变量 --function-id ` |列出变量 `appwrite 函数 create-variable --function-id --key --value ` |创建变量 `appwrite 函数 update-variable --function-id --variable-id --key --value ` |更新变量 `appwrite 函数删除变量 --function-id --variable-id ` |删除变量 ### 使用 body 触发函数 appwrite 函数创建执行 \ --function-id \ --body '{"键": "值"}' ### 本地发展 appwrite运行函数 ## 部署站点 # 创建一个新站点 appwrite初始化站点 # 从控制台拉出现有站点 appwrite 拉站点 # 部署站点 appwrite推送站点 ### appwrite.config.json 中的站点配置 { “网站”：[ { "$id": "", "name": "文档模板", “启用”：正确， “记录”：真实， “框架”：“天文”， “超时”：30， "installCommand": "npm install", "buildCommand": "npm run build", "输出目录": "./dist", “规格”：“s-1vcpu-512mb”， “buildRuntime”：“节点22”， “适配器”：“ssr”， "后备文件": "", “路径”：“站点/文档模板” } ] } ### 站点命令命令 |描述 ---|--- `appwrite 站点列表` |列出所有站点 `appwrite 站点创建` |创建一个新网站 `appwrite 站点获取 --site-id ` |通过ID获取站点 `appwrite 站点更新 --site-id ` |更新站点 `appwrite 站点删除 --site-id ` |删除站点 `appwrite 站点列表框架` |列出可用的框架 `appwrite 站点列表规范` |列出允许的规格 `appwrite 站点列表模板` |列出可用模板 `appwrite 站点 get-template --template-id ` |获取模板详细信息 `appwrite 站点列表部署 --site-id ` |列出部署 `appwrite 站点创建部署 --site-id ` |创建部署 `appwrite 站点 get-deployment --site-id --deployment-id ` |获取部署 `appwrite 站点删除部署 --site-id --deployment-id ` |删除部署 `appwrite 站点更新站点部署 --site-id --deployment-id ` |设置活动部署 `appwrite 站点更新部署状态 --site-id --deployment-id ` |取消正在进行的构建 `appwrite 站点列表变量 --site-id ` |列出变量 `appwrite 站点创建变量 --site-id --key --value ` |创建变量 `appwrite 站点更新变量 --site-id --variable-id --key --value ` |更新变量 `appwrite 站点删除变量 --site-id --variable-id ` |删除变量 `appwrite 站点列表日志 --site-id ` |列出请求日志 `appwrite site get-log --site-id --log-id ` |获取日志 `appwrite 站点删除日志 --site-id --log-id ` |删除一条日志 ## 管理表（数据库） # 创建一个新表 appwrite初始化表 # 从控制台拉出现有表 appwrite 拉表 # 部署表 appwrite推表 ### appwrite.config.json 中的表配置 { “表数据库”：[ { "$id": "", “名称”：“歌曲”， “启用”：真 } ], “表”：[ { "$id": "", "$permissions": ["创建(\"任何\")", "读取(\"任何\")"], "databaseId": "", “名称”：“音乐”， “启用”：正确， “行安全”：假， “列”：[ { “关键”：“标题”， “类型”：“varchar”， “必需”：真实， “尺寸”：255 } ], “索引”：[] } ] } ### 数据库命令命令 |描述 ---|--- `appwrite 数据库列表表 --database-id ` |列表表 `appwrite 数据库创建表 --database-id ` |创建表 `appwrite 数据库 get-table --database-id --table-id ` |获取表格 `appwrite 数据库更新表 --database-id --table-id ` |更新表 `appwrite 数据库删除表 --database-id --table-id ` |删除表 `appwrite 数据库列表列 --database-id --table-id ` |列出列 `appwrite 数据库 get-column --database-id --table-id --key ` |获取列 `appwrite 数据库删除列 --database-id --table-id --key ` |删除列 `appwrite 数据库列表索引 --database-id --table-id ` |列出索引 `appwrite 数据库 create-index --database-id --table-id ` |创建索引 `appwrite 数据库删除索引 --database-id --table-id --key ` |删除索引 ### 列类型命令 > **注意：** 旧的“string”类型已弃用。请改用显式字符串列类型。命令 |描述 ---|--- `创建 varchar 属性` | Varchar 列 — 内联存储，完全可索引（最大 16,383 个字符，完整索引的大小 ≤ 768） `创建文本属性` |文本列 — 离页存储，仅前缀索引（最多 16,383 个字符） `创建媒体文本属性` | Mediumtext 列 — 离页存储（最多约 4M 个字符） `创建长文本属性` |长文本列 — 离页存储（最多 ~1B 个字符） `创建布尔属性` |布尔列 `创建整数属性` |整数列（可选最小值/最大值） `创建浮动属性` |浮点柱（可选最小/最大） `创建电子邮件属性` |邮件栏目 `创建 url 属性` |网址栏 `创建 ip 属性` | IP地址栏 `创建日期时间属性` |日期时间列 (ISO 8601) `创建枚举属性` |枚举列（接受值的白名单） `创建关系属性` |关系栏所有列命令都使用“appwrite数据库<命令> --database-id --table-id ”。 ### 行操作 # 创建一行 appwrite 数据库创建行 \ --database-id "" --table-id "" \ --row-id 'unique()' --data '{ "title": "Hello World" }' \ --permissions '读（“任何”）' '写（“团队：abc”）' # 列出行（JSON 输出） appwrite 数据库列表行 \ --database-id "" --table-id "" --json # 获取一行 appwrite 数据库 get-row \ --database-id "" --table-id "" --row-id "" ## 管理存储桶（存储） # 创建一个新的桶 appwrite初始化存储桶 # 从控制台拉出现有的存储桶 appwrite拉桶 # 部署存储桶 appwrite推桶 ### 存储命令命令 |描述 ---|--- `appwrite 存储列表桶` |列出所有存储桶 `appwrite 存储创建桶` |创建一个桶 `appwrite storage get-bucket --bucket-id ` |拿一个桶 `appwrite storage update-bucket --bucket-id ` |更新一个存储桶 `appwrite storage delete-bucket --bucket-id ` |删除一个桶 `appwrite 存储列表文件 --bucket-id ` |列出文件 `appwrite storage create-file --bucket-id ` |上传文件 `appwrite storage get-file --bucket-id --file-id ` |获取文件元数据 `appwrite 存储删除文件 --bucket-id --file-id ` |删除文件 `appwrite storage get-file-download --bucket-id --file-id ` |下载文件 `appwrite storage get-file-preview --bucket-id --file-id ` |获取图像预览 `appwrite storage get-file-view --bucket-id --file-id ` |在浏览器中查看文件 ## 管理团队 # 创建一个新团队 appwrite初始化团队 # 从控制台拉出现有团队 appwrite拉团队 # 部署团队 appwrite 推动团队 ### 团队命令命令 |描述 ---|--- `appwrite 团队列表` |列出所有球队 `appwrite 团队创建` |创建团队 `appwrite 团队获取 --team-id ` |组建团队 `appwrite 团队更新名称 --team-id ` |更新团队名称 `appwrite 团队删除 --team-id ` |删除团队 `appwrite 团队列表成员 --team-id ` |列出成员 `appwrite 团队创建成员资格 --team-id ` |邀请会员 `appwrite 团队 update-membership --team-id --membership-id ` |更新成员角色 `appwrite 团队删除成员 --team-id --membership-id ` |删除成员 `appwrite team get-prefs --team-id ` |获取团队偏好 `appwrite 团队 update-prefs --team-id ` |更新团队偏好设置 ## 管理主题（消息传递） # 创建一个新主题 appwrite初始化主题 # 从控制台拉取现有主题 appwrite 拉取主题 # 部署主题 appwrite推送主题 ### 消息命令命令 |描述 ---|--- `appwrite 消息列表消息` |列出所有消息 `appwrite 消息创建电子邮件` |创建电子邮件消息 `appwrite 消息创建推送` |创建推送通知 `appwrite 消息创建短信` |创建短信 `appwrite 消息获取消息 --message-id ` |收到消息 `appwrite 消息删除 --message-id ` |删除一条消息 `appwrite 消息列表主题` |列出所有主题 `appwrite 消息创建主题` |创建主题 `appwrite messages get-topic --topic-id ` |获取主题 `appwrite 消息更新主题 --topic-id ` |更新一个主题 `appwrite 消息删除主题 --topic-id ` |删除主题 `appwrite 消息列表订阅者 --topic-id ` |列出订阅者 `appwrite 消息创建订阅者 --topic-id ` |添加订阅者 `appwrite 消息删除订阅者 --topic-id --subscriber-id ` |删除订阅者 ## 用户管理 # 创建用户 appwrite 用户创建 --user-id "unique()" \ --电子邮件 hello@appwrite.io \ --密码非常强密码 # 列出用户 appwrite用户列表 # 获取一个用户 appwrite 用户获取 --user-id "" # 删除一个用户 appwrite 用户删除 --user-id "" ## 生成类型安全的 SDK # 自动检测语言并生成应用程序写入生成 # 指定输出目录 appwrite生成--输出./src/生成 # 指定语言 appwrite生成--语言打字稿生成的文件：文件 |描述 ---|--- `types.ts` |数据库架构中的类型定义 `数据库.ts` |用于查询和更改行的类型化数据库助手 `常量.ts` |配置常量（端点、项目 ID） `index.ts` |导出所有助手的入口点用途：从“./ generated/appwrite”导入{数据库}； const 客户=databases.use("main").use("customers"); // 创建 const 客户 = 等待客户.create({ 姓名：“沃尔特·奥布莱恩”，电子邮件：“walter@example.com” }); // 包含类型化查询的列表 const 结果 = 等待顾客.list({ 查询：(q) => [ q.equal("姓名", "沃尔特·奥布莱恩"), q.orderDesc("$createdAt"), q.限制(10) ] }); // 更新等待客户.更新（“客户ID-123”，{ 电子邮件：“walter@scorpion.com” }); // 删除等待客户.删除（“客户ID-123”）； // 批量创建等待客户.createMany([ { 姓名：“Walter O' Brian”，电子邮件：“walter@example.com” }, { 姓名：“Paige Dineen”，电子邮件：“paige@example.com” } ]); ## 非交互式/CI/CD 模式对于没有配置文件或会话的无头自动化： # 配置客户端为非交互模式应用程序写入客户端\ --endpoint https://.cloud.appwrite.io/v1 \ --project-id <项目 ID> \ --key ### 非交互式部署 # 推动一切 appwrite推送所有--all--force # 推送特定资源 appwrite推送功能--all--force appwrite 推送函数 --function-id --force appwrite推送站点--all --force appwrite推表--all--force appwrite 推送团队 --all --force appwrite 推送存储桶 --all --force appwrite推送主题--all --force ## 全局命令选项选项 |描述 ---|--- `-v, --version` |输出版本号 `-V，--verbose` |显示完整的错误日志 `-j, --json` |以 JSON 格式输出 `-f, --force` |确认所有警告 `-a，--all` |选择所有资源 `--id [id...]` |传递 ID 列表 `--报告` |生成 GitHub 错误报告链接 `--控制台` |获取控制台的直接链接 `--打开` |在浏览器中打开控制台链接 `-h, --help` |显示帮助 ## 示例 # 列出具有 JSON 输出的用户 appwrite用户列表--json # 获取详细错误输出 appwrite 用户列表 --verbose # 在控制台中查看一行 appwrite 数据库 get-row \ --database-id "" \ --table-id "" \ --row-id "" \ --控制台--打开 # 生成错误报告 appwrite登录--报告

Appwrite CLI

包含技能