Foxmayn Frappe CLI

io.github.nasroykhv1.16.1更新于 Oct 9, 2026

Read and change documents, reports and workflows on Frappe and ERPNext sites.

概览

AI 生成的概览

让助手通过 REST API 读取和修改 Frappe 与 ERPNext 站点上的文档、报表、工作流、文件和权限。

功能
ffc 是面向 Frappe 和 ERPNext 站点的命令行工具、MCP 服务器和桌面应用。其 MCP 模式提供站点操作,例如列出和获取文档、运行报表,以及处理工作流、文件和权限,并带有按站点限制、确认提示和审计日志。输出便于脚本处理(JSON、NDJSON、CSV、--jq)。它是独立项目,与 Frappe Technologies 无关联,也未获其认可。
适用场景
当助手需要处理 Frappe 或 ERPNext 站点上的数据时使用:查询记录、生成报表,或对文档和工作流进行受控修改。若只需读取,可使用只读模式。
运行要求
作为仅限桌面的本地进程通过 stdio 运行;未声明环境变量或请求头。需要 Frappe 或 ERPNext 站点,并通过 ffc init 配置登录方式(浏览器登录、API 密钥或密码)。可通过提供的脚本、Homebrew、Scoop 或打包的 mcpb 发行版安装。
安装前请注意
它可能修改线上站点的文档、报表和工作流,因此按站点限制、确认提示和审计日志很重要;另有只读选项。站点凭据(API 密钥或密码)保存在本地。桌面测试版尚未签名,安装脚本会下载并运行发行版二进制文件,请核对校验和与来源。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Foxmayn Frappe CLI,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

ffc — Foxmayn Frappe CLI

A command line, an MCP server and a desktop app for Frappe and ERPNext sites.

Not an official Frappe project. ffc and Foxmayn Frappe Desktop are made independently by Foxmayn and are not affiliated with or endorsed by Frappe Technologies.

  • ffc works with documents, reports, workflows, files and permissions over the REST API, with output made for scripts (JSON, NDJSON, CSV, --jq).
  • ffc mcp lets AI assistants (Claude Desktop, Claude Code, Cursor, VS Code, Codex) use your sites, with per-site limits, confirmations and an audit log.
  • Foxmayn Frappe Desktop (Windows and macOS) adds sites and connects assistants without the terminal.

Install

Linux and macOS

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

Windows (PowerShell or cmd.exe)

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

Or with a package manager: brew install nasroykh/tap/ffc (macOS, Linux), or scoop bucket add foxmayn https://github.com/nasroykh/scoop-bucket then scoop install ffc (Windows).

Both scripts download the latest release for your platform and check its SHA-256 checksum. Manual downloads, building from source, signature checks, updating (ffc update) and uninstalling: Installation.

Desktop app: beta builds are not signed yet, so install them from a terminal to skip the macOS and Windows warnings (the scripts check the download):

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

Or download the desktop-v… release from the Releases page; see Install the desktop app for the first-launch steps.

Quickstart

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

Connect an AI assistant to your sites:

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

More in the Quickstart.

Documentation

TopicWhere
Install, first site, sign-in methods, config file and env varsInstallation · Authentication · Configuration
Every command, global flags, output formats, exit codes, dry runsCLI reference
MCP server: setup per client, running it, tools, safety and policyMCP
Desktop app: install, sites, assistants, updatesDesktop
Release signing, where credentials liveSecurity
Problems and questionsTroubleshooting · FAQ
Building, testing, releasing, the desktop dev loopDevelopment

The full index is docs/README.md.

For AI agents

skills/ holds agent skills for using ffc (start with ffc-core; then ffc-setup, ffc-mcp, ffc-bulk-lifecycle, ffc-reports-api, ffc-files-collab) and for working on this repository (ffc-dev and the ffc-dev-* skills). make skills-init links them into .claude/, .cursor/ and .agent/.

Contributing

Issues and pull requests are welcome. Start with Development: make build, make test, make lint. Every new command or MCP tool ships with tests against the fake Frappe site in internal/frappetest.

Credits

ffc builds on these open-source projects, with thanks to their authors:

License

MIT © 2026 Nas (Foxmayn)

来源:README.md,提交 0c23ac8

工具

0
工具元数据尚未被收录。

版本历史

1
  1. v1.16.1最新Oct 9, 2026