frappe-console

Frappe Console Command

Launch an interactive Python console with Frappe context loaded for debugging, data exploration, and executing Python commands.

Steps to Execute

1. Verify Bench Environment

• Check if current directory is a valid Frappe bench
• Verify bench command is available
• List available sites

2. Select Site

Ask user which site to use:

• List all sites in sites/ directory
• Show default site (if set with bench use)
• Get user selection or use default

3. Console Type Selection

Offer console options:

A. Standard Console (IPython)

• Full Python REPL with Frappe context
• Auto-completion and syntax highlighting
• Command history

B. One-liner Execution

• Execute single Python command
• Get result and exit
• Useful for scripts and automation

C. Script Execution

• Execute Python script file
• Run with Frappe context
• Show output

4. Launch Console

Standard Console:

bench --site [site-name] console

One-liner:

bench --site [site-name] console --execute "print(frappe.db.get_all('Customer', limit=5))"

Script File:

bench --site [site-name] console < script.py

5. Provide Console Snippets

Show common console commands for user reference:

Get Document:

# Fetch a document
doc = frappe.get_doc('Customer', 'CUST-001')
print(doc.as_dict())

Query Database:

# Get all records with filters
customers = frappe.get_all('Customer',
    filters={'customer_group': 'Commercial'},
    fields=['name', 'customer_name'],
    limit=10
)
print(customers)

Execute Queries:

# Raw SQL
result = frappe.db.sql("""
    SELECT name, customer_name
    FROM `tabCustomer`
    WHERE creation > '2025-01-01'
    LIMIT 10
""", as_dict=True)

Create Documents:

# Create new document
customer = frappe.get_doc({
    'doctype': 'Customer',
    'customer_name': 'Test Customer',
    'customer_group': 'Commercial'
})
customer.insert()
frappe.db.commit()