Twenty CRM

通过 REST/GraphQL 与自托管的 Twenty CRM 交互。

安装

概览

Twenty CRM 是一个专为自托管部署设计的命令行工具集,旨在通过 REST 和 GraphQL API 与 Twenty CRM 系统无缝交互。该工具基于 Python3 和 curl 构建,提供了一套轻量级但功能完整的脚本集合,使开发者、运维人员或自动化流程能够直接通过终端操作 Twenty CRM 中的核心数据对象。用户只需配置基础 URL 和 API 密钥即可快速接入,无需额外依赖复杂的 SDK 或中间件。所有脚本均支持环境变量注入,并默认读取 `config/twenty.env` 文件以管理敏感信息,确保安全性和可维护性。无论是查询客户信息、创建新公司记录,还是批量更新字段,Twenty CRM 都提供了直观的命令行接口,显著提升了在本地或私有环境中集成 Twenty 系统的效率。

核心功能特点

  1. 支持 REST 和 GraphQL 双协议访问 Twenty CRM API
  2. 提供标准化的命令行脚本用于 CRUD 操作(增删改查)
  3. 自动加载环境配置文件,支持灵活路径覆盖与权限控制
  4. 内置常用业务对象操作示例,如创建公司与模糊搜索
  5. 强调安全性设计,建议限制配置文件读写权限避免泄露 API Key

适用场景

Twenty CRM 命令行工具特别适用于需要直接在终端或 CI/CD 流水线中操作 Twenty CRM 数据的场景。例如,在自动化部署流程中,可通过 REST POST 脚本快速注册新客户企业信息;当系统管理员需批量导入或清理测试数据时,利用 find-companies 脚本按名称模糊匹配可大幅提升处理效率。此外,对于使用 Twenty 作为内部客户管理后台的团队而言,开发人员可在不依赖图形界面的情况下调试 API 行为,验证 GraphQL 查询结构,或编写自定义集成脚本。由于其完全基于标准网络工具(curl + python),该工具也适合在无 GUI 环境的服务器上运行,实现远程监控与运维管理。总之,任何涉及 Twenty CRM 数据自动化处理、系统集成或日常维护的任务,都能从这套简洁高效的命令行工具中获益。