Foxmayn Frappe CLI

io.github.nasroykhv1.16.1Updated Oct 9, 2026

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

VerifiedSTDIODesktop onlyBusiness & CommerceProductivity & Workflow

Overview

AI-generated overview

Lets an assistant read and change documents, reports, workflows, files and permissions on Frappe and ERPNext sites over the REST API.

What it does
ffc is a command line tool, MCP server and desktop app for Frappe and ERPNext sites. Its MCP mode exposes site operations such as listing and fetching documents, running reports, working with workflows, files and permissions, with per-site limits, confirmations and an audit log. Output is script-friendly (JSON, NDJSON, CSV, --jq). It is an independent project, not affiliated with or endorsed by Frappe Technologies.
When to use it
Use it when an assistant needs to work with data on a Frappe or ERPNext site: looking up records, producing reports, or making controlled changes to documents and workflows. A read-only mode is available when only reads are wanted.
Requirements
Runs locally as a desktop-only process over stdio; no environment variables or headers are declared. It needs a Frappe or ERPNext site and a sign-in method (browser sign-in, API key or password) configured with ffc init. Install via the provided scripts, Homebrew, Scoop, or the packaged mcpb release.
Before you install
It can change documents, reports and workflows on live sites, so per-site limits, confirmations and the audit log matter; a read-only option exists. Site credentials (API key or password) are stored locally. The desktop beta builds are unsigned, and the install scripts download and run release binaries, so verify checksums and sources.

Installation

In SourceWeft

  1. Open Foxmayn Frappe CLI in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

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)

Source: README.md at commit 0c23ac8

Tools

0
Tool metadata has not been indexed yet.

Version history

1
  1. v1.16.1LatestOct 9, 2026