Skip to content

vanbaopham160-clnp/frappe-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Frappe Plugin for Antigravity (v1.1.1)

An Antigravity plugin that equips your AI coding agent with the capability to interact with remote Frappe sites using frappe-cli. It supports querying documents, bulk actions, schema introspection, running reports, calling whitelisted API methods, and delegating complex data audits to a specialized subagent.

Dependencies & Setup

This plugin depends on the frappe-cli executable. The tool is distributed via Python as frappe-remote-cli.

Auto-Installation

If the agent detects that frappe-cli is not installed on your machine, it will automatically install it by running pip install frappe-remote-cli on your behalf.

To install it manually, run:

pip install frappe-remote-cli
# Or: pipx install frappe-remote-cli
# Or: uv tool install frappe-remote-cli

Features

  • Direct CLI Mapping: Translates natural language requests into direct frappe-cli commands.
  • Document CRUD & Count: Fetch, list, count, create, update, or delete records.
  • Client-Side Bulk Actions: Create, update, or delete lists of documents in bulk.
  • Desk Reports & Schema Introspection: Execute desk reports and query live DocType field structures.
  • Specialized Subagent: Includes frappe-query-agent to run background queries and role audits.
  • Confirmation Rules: Auto-executes read/create/bulk-create commands, while requiring manual confirmation for updates and deletions.

Repository Structure

frappe-plugin/
├── plugin.json         # Required: Metadata describing the plugin
├── mcp_config.json     # Optional: Template for future local/remote MCP servers
├── hooks.json          # Optional: Template for future event hooks
├── README.md           # Documentation for Click subcommands
├── agents/             # Custom Subagents
│   └── frappe-query-agent.md # Dedicated query subagent definition
├── skills/             # Active plugin skills
│   └── frappe-cli/
│       └── SKILL.md    # Skill instructions for command routing
└── rules/              # Guidelines
    └── frappe-rules.md # Standard constraints on queries

Installation

You can install this plugin and skill into your Antigravity setup in one of two ways:

Option A: Standard Installation (Recommended)

Use the official Agent Skills CLI to automatically download and register the plugin:

# Install globally
npx skills add github:vanbaopham160-clnp/frappe-plugin --global

Option B: Manual Setup (Local Development)

If you cloned the repository locally and want to link it manually:

  1. Link the Plugin Folder:

    ln -s /path/to/cloned/frappe-plugin ~/.gemini/config/plugins/frappe-plugin
  2. Link the Subagent:

    ln -s /path/to/cloned/frappe-plugin/agents/frappe-query-agent.md ~/.gemini/config/agents/frappe-query-agent.md

Example Prompts

Basic Queries (Auto-executed)

  • "show the last 5 user in sites mesp dev"
  • "how many active tasks are on mesp dev"
  • "show schema fields for Customer doctype on staging"

Remote RPC Execution

  • "call my_app.api.add with parameters a=10 and b=20 on staging"

Complex Audits (Delegated to frappe-query-agent)

  • "Audit the last 50 users on mesp dev, check which ones are active, list their linked roles, and write a summary report."
  • "Use the frappe-query-agent to search the last 40 users on mesp dev and find which ones have the 'System Manager' role."

About

An Antigravity plugin and skill for interacting with remote Frappe sites via frappe-cli.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors