Foxmayn Frappe CLI

ffc — Foxmayn Frappe CLI

用于 Frappe 和 ERPNext 站点的命令行工具、MCP 服务和桌面应用。

这不是官方 Frappe 项目。 ffc 和 Foxmayn Frappe Desktop 由 Foxmayn 独立开发，与 Frappe Technologies 无关联，也未获其认可。

• ffc 通过 REST API 操作文档、报表、工作流、文件和权限，输出格式适用于脚本（JSON、NDJSON、CSV、--jq）。
• ffc mcp 让 AI 助手（Claude Desktop、Claude Code、Cursor、VS Code、Codex）使用你的站点，并提供按站点设置的限制、确认机制和审计日志。
• Foxmayn Frappe Desktop（Windows 和 macOS）可添加站点，通过其助手与站点聊天，并连接 AI 应用，无需使用终端。

_{桌面助手（Claude Opus 5.5）在演示用 ERPNext 站点上的真实运行，等待时间以 4 倍速显示。启用“更改前询问”后，只有在你批准卡片后才会写入任何内容。}

安全性

连接到 ERP 的 AI 助手不应让你措手不及。ffc 和桌面应用使用你自己的 Frappe 用户权限，并且只会进一步收紧权限：

• **默认只读：**桌面应用默认只读；任何 AI 客户端只需一个标志（--read-only）或一个配置键即可设为只读。
• **按站点设置策略：**允许或拒绝使用工具、DocType 和服务器方法。除非你将用户、权限、脚本和设置列入清单，否则它们始终为只读。
• **审批：**ffc 会在删除、取消、工作流操作和共享前询问；这适用于任何能够发起询问的 AI 客户端（confirm: always 会在不支持询问的客户端中拒绝这些操作）。在桌面应用的“更改前询问”模式下，每项更改都会等待你审核卡片，卡片会显示更改前后的字段；如果自你查看文档后，站点上的文档发生了更改，则会拒绝更新。
• **审计日志：**每次工具调用，无论允许还是拒绝，都会在你的计算机上记录为一行 JSON。
• **试运行：**会写入数据的 CLI 命令均接受 --dry-run，并打印将要发送的内容。

详情与限制：MCP 安全性 · 桌面应用审批。

安装

Linux 和 macOS

curl -fsSL https://raw.githubusercontent.com/nasroykh/foxmayn_frappe_cli/main/install.sh | sh

Windows（PowerShell 或 cmd.exe）

powershell -ExecutionPolicy Bypass -Command "irm https://raw.githubusercontent.com/nasroykh/foxmayn_frappe_cli/main/install.ps1 | iex"

也可以使用包管理器：brew install nasroykh/tap/ffc（macOS、Linux），或先运行 scoop bucket add foxmayn https://github.com/nasroykh/scoop-bucket，再运行 scoop install ffc（Windows）。

这两个脚本都会下载适用于你平台的最新版本，并检查其 SHA-256 校验和。手动下载、从源代码构建、签名检查、更新（ffc update）和卸载说明：安装。

**桌面应用（测试版）：**目前尚未对构建版本进行代码签名（帮助筹集签名费用），因此通过浏览器下载时会显示 Windows SmartScreen 或 macOS Gatekeeper 警告。安装脚本会自行下载版本，并在安装前检查其 SHA-256 校验和（以及 macOS 上的发行签名）：

# macOS
curl -fsSL https://raw.githubusercontent.com/nasroykh/foxmayn_frappe_cli/main/install-desktop.sh | sh

# Windows (PowerShell or cmd.exe)
powershell -ExecutionPolicy Bypass -Command "irm https://raw.githubusercontent.com/nasroykh/foxmayn_frappe_cli/main/install-desktop.ps1 | iex"

或者从 Releases 页面下载 desktop-v… 版本；首次启动步骤请参阅安装桌面应用。

快速入门

ffc init                                   # add your first site (browser sign-in, API key or password)
ffc whoami                                 # who you are on the site, roles, Frappe version
ffc list-docs -d Customer -f name,customer_name -l 5
ffc get-doc -d "Sales Invoice" -n ACC-SINV-2026-00001 --json
ffc list-docs -d ToDo --filters '{"status":"Open"}' --output csv > todos.csv

将 AI 助手连接到你的站点：

ffc mcp install --client claude-desktop    # or claude-code, cursor, vscode, codex; --read-only allows reads only

更多内容请参阅快速入门。

文档

主题	位置
安装、创建第一个站点、登录方式、配置文件和环境变量	安装 · 身份验证 · 配置
所有命令、全局标志、输出格式、退出代码、试运行	CLI 参考
MCP 服务：各客户端的设置、运行方式、工具、安全和策略	MCP
桌面应用：安装、站点、助手、连接应用、更新	桌面应用
发布签名、凭据存放位置	安全
问题与疑问	故障排查 · 常见问题
构建、测试、发布、桌面开发循环	开发

完整索引见 docs/README.md。

面向 AI Agent

skills/ 中包含用于使用 ffc 的 Agent 技能（从 ffc-core 开始；然后使用 ffc-setup、ffc-mcp、ffc-bulk-lifecycle、ffc-reports-api、ffc-files-collab），以及用于参与此代码库开发的技能（ffc-dev 和 ffc-dev-* 系列技能）。make skills-init 会将它们链接到 .claude/、.cursor/ 和 .agent/ 中。

支持

ffc 免费，并将一直免费。如果它为你节省了时间，可以通过 Ko-fi 支持其开发。首要目标是进行代码签名，让桌面应用能在 Windows 和 macOS 上安装而不会出现安全警告；之后是测试服务器和开发工具。已经在使用 Wise？你也可以通过 Wise 转账。

贡献

欢迎提交问题和拉取请求。请从开发指南开始：make build、make test、make lint。每个新增命令或 MCP 工具都附带针对 internal/frappetest 中模拟 Frappe 站点的测试。

致谢

ffc 基于以下开源项目构建，谨向其作者致谢：

• CLI 和 MCP 服务： Cobra 和 pflag、Charm（Lip Gloss、Huh、Bubbles、colorprofile）、Resty、gojq、mcp-go、hujson、go-yaml、go-isatty 以及 Go x/sys 软件包。
• 桌面应用： Wails、React、Base UI、shadcn/ui、Tailwind CSS、Tabler Icons、Nunito Sans（通过 Fontsource）、cmdk、Embla Carousel、Vite 以及 desktop/frontend/package.json 中的其他软件包。
• 发布工具： GoReleaser 和 NSIS。
• Frappe Framework 和 ERPNext，本项目所连接的开源平台。Frappe 和 ERPNext 是各自所有者的商标，此处仅用于说明兼容性。

许可证

MIT © 2026 Nas (Foxmayn)