frappecli for Openclaw

A powerful command-line interface for interacting with Frappe Framework and ERPNext instances through the REST API.

pasogott
v0.1.1
Jan 9, 2026
1
3.2k
0

Install & Download

1. ClawHub CLI

The fastest way to install a skill directly from the registry.

npx clawhub@latest install frappecli

2. Manual Installation

Copy the skill folder to one of these locations

Global
~/.openclaw/skills/
Workspace
<project>/skills/

Priority: Workspace > Local > Bundled

3. Prompt Installation

Copy this prompt to OpenClaw to install it automatically.

Help me install frappecli using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).

Prefer to download?

Get the raw skill files in a ZIP archive.

What is frappecli?

frappecli is a specialized tool designed to streamline the management of Frappe Framework and ERPNext environments directly from your terminal. By leveraging the Frappe REST API, this utility allows developers and administrators to perform complex operations on doctypes, documents, and system files without navigating the web UI. As a featured part of the Openclaw Skills library, it provides a bridge between automated workflows and your ERP data.

The tool is particularly effective for those who need to handle multi-site environments, providing a centralized configuration for switching between production and staging sites. Whether you are automating backups, performing bulk data migrations, or integrating with external CI/CD pipelines, frappecli offers the flexibility and speed required for modern enterprise development.

frappecli Use Cases

  • Automating bulk document updates or deletions within ERPNext.
  • Uploading and downloading private or public files for specific records.
  • Running and exporting complex financial reports to CSV or JSON for external analysis.
  • Calling custom Python RPC methods on a Frappe site for remote procedure execution.
  • Integrating ERPNext data into shell scripts or automated devops pipelines.

How frappecli Works

  1. The user configures site credentials including URLs and API keys in a local YAML configuration file.
  2. Commands are issued via the CLI, specifying the target site and the desired operation such as document listing or file uploads.
  3. The tool authenticates with the Frappe server using the provided API secrets.
  4. frappecli translates CLI flags and data into REST API requests sent to the Frappe instance.
  5. Server responses are parsed and presented in the user's preferred format, such as pretty tables, JSON, or CSV.

frappecli Setup

Installation

Install via Homebrew:

brew tap pasogott/tap
brew install frappecli

Or from source using uv:

git clone https://github.com/pasogott/frappecli.git
cd frappecli && uv sync && uv pip install -e .

Configuration

Initialize your environment by creating ~/.config/frappecli/config.yaml:

sites:
  production:
    url: https://erp.company.com
    api_key: your_api_key
    api_secret: your_api_secret
  staging:
    url: https://staging.company.com
    api_key: your_staging_key
    api_secret: your_staging_secret

default_site: production

frappecli Data Schema & Taxonomy

The skill interacts with Frappe's metadata-driven architecture to organize data as follows:

Entity Description
Doctypes The schema definitions (e.g., Customer, Sales Invoice)
Documents Individual records within a Doctype
Files Physical attachments (private or public) linked to records
Reports Pre-defined queries and analytics engines
RPC Methods Whitelisted server-side Python functions

frappecli Advanced Features

  • Multi-site management with easy switching between default environments.
  • Advanced filtering using JSON syntax for precise document retrieval within Openclaw Skills workflows.
  • Support for various output formats including JSON and CSV to facilitate piping to other tools like jq.
  • Direct execution of remote procedure calls (RPC) for custom app logic integration.
  • Bulk operations support for exporting and updating large datasets efficiently.

SKILL.md


Loading

Related Openclaw Skills

METADATA

Github Stars: 0
forks: 0

Featured*