Agent skill · software engineering · aiskillstore
appflowy-api
AppFlowy Cloud/GoTrue API 的认证与调用流程（获取 token、workspace/文档/数据库/搜索等）。在本仓库用 Python 编写或调试 AppFlowy API 客户端、脚本、自动化或排查接口问题时使用。
Why this skill is useful
Adds multiple executable scripts for AppFlowy API automation that extend the AI's capabilities beyond standard API knowledge.
What it needs
Requires python installed locally. Requires gotrue account access. About 4k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
AppFlowy API 概述 本 skill 用于自托管 AppFlowy 环境的 API 调用与自动化，覆盖登录鉴权、文档/视图/数据库操作、搜索、协作数据（collab）等常见场景。默认不读取 .env，仅在显式传入 --env <path> 时读取。 本 skill 当前适配 AppFlowy Cloud 0.12.3。doctor.py 会通过 /api/health 检测版本并在不匹配时给出警告。 快速开始 1. 准备 base URL 与 GoTrue URL（可选 --env <path> 读取 .env）。 2. 使用账号密码获取 accesstoken。 3. 携带必要请求头调用 AppFlowy API。 统一入口（推荐） 统一入口脚本用于封装命令风格，适合自动化与外部集成： 配置优先级 解析优先级（从高到低）： 1. 命令行参数：--base-url、--gotrue-url、--client-version、--device-id 2. 配置文件：--config <path>（JSON，示例见 skills/appflowy-api/references/config.example.json） 3. 环境变量：APPFLOWYBASEURL、APIEXTERNALURL、APPFLOWYGOTRUEBASEURL 4. .env 文件：仅在传入 --env <path> 时读取 常用脚本 子内容规则（子任务 / 子项 / 子 Grid） 1. 子任务（Checklist/Todo 列）：适用于简单描述的子内容，不需要额外字段。 2. 子项（Relation 列）：当子内容与父级字段结构一致时，通过关联行管理。 3. 子 Grid：当子内容需要独立字段结构时，新建 Grid 并在父级引用或说明。 Grid 默认空行处理 新建 Grid 时可能自动生成 3 条空行。脚本在写入数据前会清理默认空行，避免空行混入真实计划。 Select 写入规则（重要） 1. SingleSelect/MultiSelect 行值写入时应使用选项名称（例如："状态": "进行中"、"标签": ["核心", "风险"]）。 2. 不要把 selectedoptionids 直接作为 SingleSelect/MultiSelect 行值提交给 REST row API，否则容易触发 HTTP 400。 3. selectedoptionids 仅适用于 Checklist（子任务）字段结构。 必需请求头 所有 AppFlowy API 请求均需携带： 1. Authorization: Bearer <accesstoken> 2. client-version: <AppFlowy 版本>（建议与部署版本一致） 3. client-timestamp: <Unix 毫秒> 4. device-id: <UUID> 错误处理与排障 1. HTTP 200 但响应体包含 success=false 或 error 视为业务失败。 2. 控制台提示无法连接时，优先检查宿主机 80/443 可达性与防火墙规则。 3. 容器间调用优先使用内部地址（如 http://gotrue:9999、http://appflowycloud:8000）。 4. 删除行时，/database/{databaseid}/row 没有 DELETE 路由；应使用 deleterows.py 通过 collab 更新 roworders 完成删除。 5. database-query 的 --query-file 支持 UTF-8/UTF-8 BOM（Windows PowerShell 导出的 UTF-8 也可读取）。 6. 字段改名/字段删除当前通过 collab 更新实现；其中字段删除默认 dry-run，执行必须显式传入 --execute --yes。 7. M3 统一输出协议：高风险/批量命令返回 changereport（before/plan/after/summary 四段）。 8. v0.3 M1 新增 schema-diff 与 schema-migration-plan，两者均输出 changereport。 9. schema-diff 中的 renamecandidates 是“建议项”，后续执行仍应优先以 fieldid 二次确认。 10. v0.3 M2 新增 apply-schema-migration，默认 dry-run；执行需要 --execute --yes，并对高风险操作要求额外确认参数。 11. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/appflowy-api