README.md

May 12, 2026 · View on GitHub

Frappe Script Editor

Edit Frappe doctype script fields directly in VS Code with data sync on save

Features

  • Edit Scripts in VS Code: — Edit JavaScript, Python, HTML, and CSS scripts of Frappe doctypes
  • Sync on Save — Changes automatically sync back to your Frappe site when you save
  • Multi-Site Support — Manage and switch between multiple Frappe sites

Installation

From VSCode Marketplace

https://marketplace.visualstudio.com/items?itemName=PratikBadhe.frappe-script-editor

From Source

1. Clone and Build

git clone https://github.com/frappe/frappe-script-editor.git
cd frappe-script-editor
yarn install
yarn compile

2. Install Extension

Choose one of the following methods:

Method A: VS Code Command Palette (Recommended)

  1. Open VS Code
  2. Press Cmd+Shift+P (macOS) or Ctrl+Shift+P (Windows/Linux) to open the Command Palette
  3. Type Developer: Install Extension from Location and select it
  4. Navigate to and select the frappe-script-editor folder
  5. Restart VS Code

Method B: Manual Installation

  1. Copy the extension folder to your VS Code extensions directory:
# For macOS/Linux
cp -r frappe-script-editor ~/.vscode/extensions

# For Windows
xcopy /e /i frappe-script-editor %USERPROFILE%\.vscode\extensions\frappe-script-editor
  1. Restart VS Code

Setup

1. Generate API Credentials in Frappe

  1. Login to your Frappe site
  2. Go to User > Your User > API Access
  3. Generate a new API Key and API Secret
  4. Save these credentials securely

2. Add Your Site in VS Code:

  1. Open the Frappe Script Editor sidebar (click the Frappe icon in the Activity Bar)
  2. Click "Add Site"
  3. Enter:
    • Site Name — A friendly name for your site
    • Site URL — Your Frappe site URL (e.g., https://your-site.com)
    • API Key — The key generated above
    • API Secret — The secret generated above
  4. Click Add Site

Usage

Browsing and Editing Scripts

  1. Expand your connected site in the Frappe Script Editor sidebar
  2. Click any script to open it in the editor
  3. Make your changes and Save (Cmd/Ctrl + S)
  4. Changes are automatically synced to your Frappe site

License

AGPL-3.0 license — see license.txt for details.

Support