Frappe Inspector for VS Code and Cursor

Frappe Inspector adds Frappe Framework and ERPNext project awareness to VS Code and Cursor. It reads project files as text and never executes project code.

On the 22-case controlled Frappe-specific benchmark, Frappe Inspector 1.4.0 detects all 20 expected findings with 0 false positives, including 3 migration-only findings. On the 17-finding generic subset, Bandit 1.9.4 detects 2 with 3 false positives, and Semgrep 1.172.0 detects 1 with 0 false positives. This is a controlled Frappe benchmark, not a global claim over every static analyzer.

Quick start

Open a Frappe bench or one Frappe app as the first folder in the workspace.
Press Ctrl+Shift+P on Windows/Linux or Cmd+Shift+P on macOS.
Run Frappe Inspector: Scan Project.
Open the Frappe Inspector icon in the Activity Bar to browse DocTypes and detected problems.

Projects containing hooks.py or sites/apps.txt are detected automatically. Use Scan Project when opening a smaller app folder that does not contain one of these files.

Community features

Community features work without an account or license.

Browse DocTypes and fields

Run Scan Project, then open the Frappe Inspector view. Expand an app, module and DocType to inspect its fields. Select a DocType or field to open its JSON definition.

Explore the DocType graph

Run Frappe Inspector: Show DocType Graph or select the graph icon in the DocTypes view title. The interactive graph groups DocTypes by app and module and displays Link, Table, and Table MultiSelect relationships. Drag nodes, pan, zoom, filter Links or Tables, and double-click a DocType or relation to open its JSON source. Missing relation targets are shown explicitly instead of being hidden.

Find definitions

Place the cursor on a quoted DocType or field recognized by Frappe Inspector, then use Go to Definition (F12). DocTypes resolve to their JSON file. Fields resolve inside a recognized frappe.ui.form.on form context.

Use Frappe-aware completion

Completion is available for DocType names in common frappe.get_doc, frappe.new_doc, frappe.get_all, frappe.get_list, database and form calls. Inside frappe.ui.form.on, completion also covers recognized frm.doc fields and common field methods.

Review diagnostics

Community analysis reports malformed DocType JSON, unknown Link targets, unknown DocType references, invalid hooks, invalid patch entries and high-confidence security flows from exposed Frappe methods. Findings appear in the editor Problems panel and the Frappe Inspector Problems view. Security diagnostics include related entrypoint, helper and sink locations plus concise fix guidance when the path is statically provable.

Use these settings when needed:

frappeInspector.scanOnSave: rescan supported project files after save.
frappeInspector.severity: minimum editor diagnostic severity.
frappeInspector.baseRef: default Git baseline used by Universal Pro.

Export a Markdown report

Press Ctrl+Shift+P or Cmd+Shift+P, run Frappe Inspector: Export Report, and select Markdown. Markdown export is included in Community.

Universal Pro features

Universal Pro adds project-wide inference, migration analysis and automation formats.

VS Code/Cursor 1.4.0 adds base-ref new-finding review, migration-plan review, repository policy/suppression management, suppression creation with justification/author/expiry, and self-contained HTML export. PR comments remain a GitHub Action feature. JetBrains stays on its separate 1.2.2 feature set and Marketplace license.

Buy Universal Pro

Purchase a monthly or annual subscription at https://frappeinspector.xyz/pricing. Paddle handles checkout and sends the FI-PRO-... license key by email. The same subscription covers VS Code, Cursor, CLI, MCP and GitHub Action usage, with up to three persistent devices.

Activate Universal Pro

Press Ctrl+Shift+P or Cmd+Shift+P.
Run Frappe Inspector: Activate Universal Pro.
Paste the FI-PRO-... key received after purchase.

The key and its short-lived signed certificate are stored in VS Code Secret Storage. A personal subscription supports up to three active devices.

Check the license

Run Frappe Inspector: License Status for the local Community or Universal Pro state. Run Frappe Inspector: Manage Universal Pro to see the account, subscription, certificate expiry and active-device count.

Compare a schema with Git

Open the project inside its Git repository.
Set frappeInspector.baseRef if the default origin/main is not appropriate.
Run Frappe Inspector: Compare With Git Ref.
Confirm the baseline ref.

The Migration Safety Analyzer reports removed DocTypes and fields, references that still use removed fields, type and Link-target changes, newly required fields without defaults, uniqueness changes and other schema risks.

Analyze Custom Fields and Property Setters

Pro scans fixture-defined Custom Fields and Property Setters as schema overlays. These fields participate in navigation, field validation and migration analysis.

Use advanced diagnostics

Pro adds unknown-field detection in supported Frappe patterns and checks references to locally defined whitelisted methods.

Export JSON or SARIF

Run Frappe Inspector: Export Report, then choose JSON or SARIF. Use JSON for tooling integrations and SARIF for compatible code-scanning systems.

Version 1.4.0 adds a self-contained HTML report for human review and archival. HTML reports are local artifacts; they do not upload source code to a hosted Frappe Inspector dashboard.

Manage devices and billing

Frappe Inspector: Deactivate This Device removes this installation from the three-device allowance and returns the editor to Community.
Frappe Inspector: Open Billing Portal opens the customer account for subscription management.

Command reference

Open the Command Palette with Ctrl+Shift+P or Cmd+Shift+P, then type Frappe Inspector.

Command	Edition	Purpose
Scan Project	Community	Scan the current Frappe workspace and refresh diagnostics.
Show DocType Graph	Community	Explore Link and child-table relationships visually.
Compare With Git Ref	Pro	Analyze schema and migration changes against Git.
Export Report	Community/Pro	Export Markdown, or Pro JSON/SARIF.
Activate Universal Pro	Community	Activate this installation with an `FI-PRO-...` key.
License Status	Community	Show the local feature state.
Manage Universal Pro	Community	Open subscription, certificate and device details.
Deactivate This Device	Community	Release this device activation.
Open Billing Portal	Community	Open the customer account.

Requirements and limits

VS Code or Cursor compatible with VS Code 1.96 or newer.
The first workspace folder is scanned.
Git and a reachable local or remote ref are required for migration comparison.
Static analysis is conservative and does not replace Frappe runtime or database validation.

CLI, MCP and GitHub Action

Universal Pro also works outside the editor:

CLI: install @frappe-inspector/cli from https://www.npmjs.com/package/@frappe-inspector/cli for local scans, migration comparisons, JSON and SARIF reports.
MCP server: install @frappe-inspector/mcp from https://www.npmjs.com/package/@frappe-inspector/mcp or open the MCP Registry at https://prod.registry.modelcontextprotocol.io/ and search for io.github.Belius303/frappe-inspector.
GitHub Action: use https://github.com/marketplace/actions/frappe-inspector for pull-request annotations, migration checks and CI summaries.
Downloads and release notes: https://github.com/Belius303/frappe-inspector-support/releases
Star / follow the project: https://github.com/Belius303/frappe-inspector-support

Example SARIF finding:

{
  "ruleId": "FI-MIGRATION-REQUIRED-FIELD",
  "level": "error",
  "message": {
    "text": "Sales Invoice.due_date is required but existing rows may not be backfilled."
  },
  "locations": [
    {
      "physicalLocation": {
        "artifactLocation": {
          "uri": "erpnext/patches/v15_0/backfill_due_date.py"
        },
        "region": {
          "startLine": 12
        }
      }
    }
  ]
}

Support, documentation and issue reports: https://github.com/Belius303/frappe-inspector-support

Frappe Inspector is independent and is not affiliated with or endorsed by Frappe Technologies, ERPNext, Microsoft, Cursor, JetBrains, or the Eclipse Foundation.

Frappe Inspector

mohamedtazihnyine