Foxmayn Frappe CLI

السجل الرسمي الإنتاجية

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

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

MCPB package https://github.com/nasroykh/foxmayn_frappe_cli/releases/download/v1.21.1/ffc_1.21.1.mcpb

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. ffc — Foxmayn Frappe CLI
  2. Install
  3. Quickstart
  4. Documentation
  5. For AI agents
  6. Support
  7. Contributing
  8. Credits
  9. License

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, chats with them through its Assistant and connects AI apps, without the terminal.

Install

Linux and macOS

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

Windows (PowerShell or cmd.exe)

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):

# 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"

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

Quickstart

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

Connect an AI assistant to your sites:

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, the Assistant, connecting apps, 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/.

Support

ffc is free and stays free. If it saves you time, you can support its development on Ko-fi. The first goal is code signing, so the desktop app installs on Windows and macOS without security warnings; then test servers and development tools. Already use Wise? You can also send through Wise.

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)

الأسئلة الشائعة

ما هو Foxmayn Frappe CLI؟

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

كيف أثبّت Foxmayn Frappe CLI؟

اتبع خطوات التثبيت في توثيقه المعروض في هذه الصفحة وفي مستودعه.

هل يحتاج Foxmayn Frappe CLI إلى مفتاح API؟

لا يذكر إدراجه في السجل أي مفتاح أو سر إلزامي. قد تتطلب بعض الميزات حسابًا لدى الخدمة التي يتصل بها.

هل Foxmayn Frappe CLI مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون Foxmayn Frappe CLI؟

ينشره nasroykh. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.