Frappe v15 ReferenceComplete Developer Documentation & Handbook

Deep technical breakdown of Frappe Framework v15 — APIs, DocTypes, Hooks, Query Builder, JS SDK, REST, Security, Reports, DevOps & Docker.

Get Started

DevOps Setup

Frappe Docker

Searchable API Index

Database & Query Builder

Complete reference for frappe.db.get_value, get_all, PyPika QueryBuilder, SQL parameters, savepoints, and transactions.

DevOps & Installation

Tabbed OS installation commands for Node, Python, MariaDB, Redis, and Bench across macOS, Linux, Windows WSL2, and Docker.

Operations & Monitoring

Monitor Supervisor status, restart web/worker processes, inspect MariaDB threads, kill long queries & release Redis load.

Production Frappe Docker

Official Frappe Docker containerization, compose.yaml, pwd.yml, custom app images, site creation & Kubernetes Helm deployment.

Complete Reports Engine

Master Standard Reports, Query Reports, Script Reports, Tree Reports, Frappe Charts, KPI summary cards & MultiSelect filters.

Cookbook & Recipes

Practical code recipes for real-world ERPNext / Frappe developer patterns and common anti-patterns to avoid.

Why This Reference?

This documentation website is designed specifically for Frappe Framework v15 developers who need clear, precise, and actionable reference material without guesswork. Every API is documented with:

Exact Syntax & Type Annotations (Python & JavaScript)
Tabbed DevOps Installation Commands (macOS, Linux, Windows WSL2, Package Managers & Docker)
Production Operations & Load Relief (Supervisor monitoring, Nginx reload, MariaDB thread inspection, Redis flush)
Frappe Docker Containerization (Docker Compose, pwd.yml, custom app images, Helm Kubernetes chart)
Detailed Parameter Matrices & Decision Tables (Which method to use when, why & how)
Complete Reporting Engine Guide (Standard, Query, Script, Tree Reports, Frappe Charts & MultiSelect filters)
Client vs. Server Boundary Distinctions
Executable & Realistic Code Examples

Quick Code Example: Data Fetching Decision Strategy

python

import frappe
from frappe.query_builder import DocType

# 1. ORM / Document API (Modifying entity & triggering lifecycle hooks)
task_doc = frappe.get_doc("Task", "TASK-2026-00001")

# 2. Database API (Fast scalar read)
task_subject, status = frappe.db.get_value(
    "Task",
    {"name": "TASK-2026-00001"},
    ["subject", "status"]
)

# 3. List Read - Enforces User Permissions (frappe.get_list)
user_tasks = frappe.get_list(
    "Task",
    filters={"docstatus": 0},
    fields=["name", "subject", "status"]
)

# 4. List Read - Bypasses Permissions / System Code (frappe.get_all)
all_tasks = frappe.get_all(
    "Task",
    filters={"docstatus": 0},
    fields=["name", "subject", "status"]
)