SuperAPI AI 工具集

deploy-function

部署与运维

查看项目

更新于 10-16 11:26

技能介绍

用途

deploy-function 是 Appwrite Codex 插件中的技能,用于使用 Appwrite CLI 部署函数,覆盖从本地开发到 CI/CD 的部署流程。

前置条件

  • 已安装 Appwrite CLI:npm install -g appwrite-cli
  • 已通过 appwrite login 完成认证
  • 已通过 appwrite init 初始化项目

主要能力

快速部署

appwrite push functions

完整工作流

  1. 初始化新函数:appwrite init functions,该命令会生成带起始模板的函数并将其加入 appwrite.config.json。
  2. 从控制台拉取已有函数:appwrite pull functions。
  3. 配置:函数在 appwrite.config.json 中配置,示例包含 projectId、endpoint、functions 数组,其中函数对象含 $id、name、enabled、live、logging、runtime、deployment、vars、events、schedule、timeout、entrypoint、commands、version、path 等字段。
  4. 部署:appwrite push functions。

CI/CD(非交互)

先设置无头模式:

appwrite client \
    --endpoint https://<REGION>.cloud.appwrite.io/v1 \
    --project-id <PROJECT_ID> \
    --key <API_KEY>

然后非交互式部署:

# 推送所有函数
appwrite push functions --all --force

# 推送指定函数
appwrite push functions --function-id <FUNCTION_ID> --force

# 一次性推送所有资源(函数、tables、buckets、teams、topics)
appwrite push all --all --force

函数管理命令

  • 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 get-deployment --function-id <ID> --deployment-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 create-execution \
    --function-id <FUNCTION_ID> \
    --body '{"key": "value"}'

环境变量命令

  • 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 run functions

该命令会启动本地开发服务器,监听文件变化并自动重新构建。

适用场景

适用于需要借助 Appwrite CLI 部署、管理和调试 Appwrite 函数的开发与运维流程,包括本地开发、手动部署和 CI/CD 非交互部署。

限制

资料未说明该技能的收费、价格、平台限制或部署配额等信息,暂未提供。