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.

Quick start

1. Open a Frappe bench or one Frappe app as the first folder in the workspace.
2. Press Ctrl+Shift+P on Windows/Linux or Cmd+Shift+P on macOS.
3. Run Frappe Inspector: Scan Project.
4. 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 and invalid patch entries. Findings appear in the editor Problems panel and the Frappe Inspector Problems view.

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.

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

1. Press Ctrl+Shift+P or Cmd+Shift+P.
2. Run Frappe Inspector: Activate Universal Pro.
3. 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

1. Open the project inside its Git repository.
2. Set frappeInspector.baseRef if the default origin/main is not appropriate.
3. Run Frappe Inspector: Compare With Git Ref.
4. 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.

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.

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 to expose read-only Frappe analysis tools to compatible AI clients.
• GitHub Action: use https://github.com/Belius303/frappe-inspector-action for pull-request annotations, migration checks and CI summaries.
• Downloads and release notes: https://github.com/Belius303/frappe-inspector-support/releases

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.