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