Erpnext Demo Gen
Generates realistic, removable demo data for ERPNext v16+: India, US, UAE and Germany, with verify, uninstall and snapshots
- Author: thava
- Repository: https://github.com/thava/erpnext_demo_gen
- GitHub stars: 4
- Forks: 0
- License: GPL-3.0
- Category: Localization
- Maintenance: Actively Maintained
Install Erpnext Demo Gen
bench get-app https://github.com/thava/erpnext_demo_gen
Tags
- demo-data
- erpnext
- erpnext-app
- frappe
- frappe-app
- test-data
Add the Frappe Gems badge to your README
Maintain Erpnext Demo Gen? Paste this into your README:
[](https://frappegems.com/gems/apps/thava/erpnext_demo_gen)
About Erpnext Demo Gen
erpnextdemogen: Demo Generator for ERPNext
Fills an ERPNext site with realistic demo data. One command adds it; one command removes it.
What it does
- Creates a demo company with months or years of business history.
- The history has quotations, orders, deliveries, invoices, payments, returns, stock and bank transfers, plus the company's own office supplies.
- Each country gets its own tax set-up, chart of accounts, addresses, banks and names.
verifychecks the result: ledgers balance, reports match invoices, tax is right.uninstallremoves everything the demo created. Your own data stays.- The same options give the same data, on any site.
Countries and packs (a pack is a type of business):
India furniture_store, electrical_distributor
United States furniture_store
UAE furniture_store
Germany furniture_store
Requirements
- frappe and erpnext version 16, or their
developbranch (the next major version). - The setup wizard is finished, for the demo's country and currency. For example, a German demo needs a site set up for Germany, in EUR.
- The Redis queue is running (
bench start). Uninstall needs it. - India only: the india_compliance app.
Installation
The examples in this README use a site called demo.localhost.
bench get-app https://github.com/thava/erpnext_demo_gen
bench --site demo.localhost install-app erpnext_demo_gen
Command summary
A quick reference. The tutorial below explains each option with examples.
bench --site demo-gen list-packs
bench --site demo-gen install --country IN|US|AE|DE [--pack NAME] [--size small|medium|large]
[--seed N] [--end-date YYYY-MM-DD] [--home-state STATE] [--demo-company-name NAME]
[--use-wizard-company] [--no-gst | --fictitious-gstin] [--force] [--verbose]
bench --site demo-gen status
bench --site demo-gen history [--run DD-RUN-00001] [--limit 20]
bench --site demo-gen verify [--run DD-RUN-00001]
bench --site demo-gen uninstall [--run DD-RUN-00001] [--yes] [--registry-only] [--no-backup]
bench demo-gen snapshot build --country IN|US|AE|DE [--pack NAME] [--size medium] [--seed N]
bench demo-gen snapshot new-site NAME DUMP.sql.gz [--admin-password PW]
Tutorial
Install, check, remove
Install an Indian demo:
bench --site demo.localhost demo-gen install --country IN
The output looks like this (shortened):
Pack: furniture_store (its default pack), country: India (IN), currency INR
Started DD-RUN-00009
Setting up the company, warehouses, fiscal years and bank accounts...
Company: Indigo Brass Home Studio Pvt Ltd
Plan: 1196 documents
Writing them takes about 4 min; please wait. Progress is shown every 20 s. ...
201 of 1196 documents written (16%), 20 s so far, about 2 min left
...
DD-RUN-00009 completed: 1210 documents in Indigo Brass Home Studio Pvt Ltd after 5 min
Check it with: demo-gen verify. Remove it with: demo-gen uninstall.
--countryis the only required option.- Each install is a run with its own number (
DD-RUN-00009). - The run creates a new company. Its name is made up (here "Indigo Brass Home Studio Pvt Ltd").
- The size is
mediumby default: 12 months of data, about 1,200 documents.
Check the result:
bench --site demo.localhost demo-gen verify
DD-RUN-00009 (Indigo Brass Home Studio Pvt Ltd)
ok trial balance balances: debit - credit = 0.00
ok receivable aging matches outstanding: report 1,886,615.00, invoices 1,886,615.00, ...
ok no negative stock: 0 ledger rows below zero
ok taxable documents have GST rows: all present
ok payments use every planned mode: Card - ICICI: 16, Cash: 31, Cheque: 27, ...
...
19/19 checks passed
verifyexits with code 1 if any check fails, so scripts and CI can use it.- The checks depend on the country. For example, Germany adds VAT checks.
Remove it:
bench --site demo.localhost demo-gen uninstall
Delete demo data of DD-RUN-00009 (Indigo Brass Home Studio Pvt Ltd)? [y/N]: y
Deleting transactions of Indigo Brass Home Studio Pvt Ltd (Transaction Deletion Record)
Deleting the demo's customers, suppliers, items and other setup records...
DD-RUN-00009 uninstalled after 29 s
- Uninstall deletes the whole demo company.
- That includes anything you added to the demo company yourself while exploring.
- Add
--yesto skip the question (useful in scripts).
See what is installed
bench --site demo.localhost demo-gen status
DD-RUN-00009 Completed: furniture_store (IN)/medium seed 1, data up to 2026-11-11, company Indigo Brass Home Studio Pvt Ltd
1210 documents; since 2026-11-11 04:40
Runs on this site: 9 (1 completed, 8 uninstalled). Details: demo-gen history
bench --site demo.localhost demo-gen history --limit 4
2026-11-11 04:40 DD-RUN-00009 installed after 5 min (Created 187, Submitted 1023)
2026-11-11 04:36 DD-RUN-00009 install started: furniture_store (IN)/medium seed 1, ...
2026-11-10 04:25 DD-RUN-00008 uninstalled after 17 s (Deleted 286)
2026-11-10 04:24 DD-RUN-00008 uninstall started
... 30 older events (--limit)
bench --site demo.localhost demo-gen history --run DD-RUN-00009 # one run, with counts per doctype
Choose the country
--country takes a code or a name. Case, spaces and hyphens do not matter.
bench --site demo.localhost demo-gen install --country IN # or india
bench --site demo.localhost demo-gen install --country US # or USA, "United States", united-states
bench --site demo.localhost demo-gen install --country AE # or UAE, united-arab-emirates
bench --site demo.localhost demo-gen install --country Germany # or DE, Deutschland
- There is no default country. The country decides the tax rules, so you always choose it.
- The site's setup wizard must match: an Indian site for
IN, a German site forDE.
Choose the pack
List the packs:
bench --site demo.localhost demo-gen list-packs
Pack Countries Sizes Title
electrical_distributor IN small, medium, large Electrical Equipment Distributor
furniture_store AE, DE, IN, US small, medium, large Furniture Store; ...
Default pack per country: AE furniture_store, DE furniture_store, IN furniture_store, US furniture_store
bench --site demo.localhost demo-gen install --country IN --pack electrical_distributor
bench --site demo.localhost demo-gen install --country IN # furniture_store, the default for India
--packis optional. Each country has a default pack.- One pack can exist in several countries. The country is not part of the pack name.
Choose the size
bench --site demo.localhost demo-gen install --country US --size small # 3 months, about 300 documents, 1 minute
bench --site demo.localhost demo-gen install --country US # medium: 12 months, about 1,200 documents, 5 minutes
bench --site demo.localhost demo-gen install --country US --size large # 24 months, about 19,000 documents, 1 to 2 hours
smallis for quick tests and bug reports. It still has every kind of document the demo makes, but few customers and items.mediumis the default and suits most demos.largelooks like a real business, but takes an hour or more. Download a ready-made snapshot instead, and restore it in seconds.- Times for every pack are under Sizes.
Get the same data again, or different data
bench --site demo.localhost demo-gen install --country IN --seed 7
- The seed picks the names, items, customers and amounts. The default is 1.
- The same seed, options and
--end-dategive the same data on any site. Without--end-date, the data ends today, so dates shift from day to day. - A different seed gives a different company with different data.
bench --site demo.localhost demo-gen install --country IN --end-date 2026-03-31
- Data ends on
--end-date. The default is today. 2026-03-31ends the data at the close of India's fiscal year.
Name the demo company
bench --site demo.localhost demo-gen install --country US --demo-company-name "Lone Star Furniture Inc"
# Creates the company "Lone Star Furniture Inc" and makes it the default company.
# It is registered as ERPNext's demo company, so the desk's
# "Delete Demo Data" button removes it, the same way uninstall does.
bench --site demo.localhost demo-gen uninstall --yes
# Deletes "Lone Star Furniture Inc" and restores the default company you had before.
- Without
--demo-company-name, the name is made up from the seed.
Choose the home state
The demo company's address is in the pack's home state. Change it with --home-state:
bench --site demo.localhost demo-gen install --country IN --home-state MH # Maharashtra (default: Tamil Nadu)
bench --site demo.localhost demo-gen install --country IN --home-state 27 # the same, by GST state code
bench --site demo.localhost demo-gen install --country AE --home-state SH # Sharjah (default: Dubai)
bench --site demo.localhost demo-gen install --country DE --home-state HH # Hamburg (default: Bayern)
- India: any state or union territory, by name ("Maharashtra"), two-letter code (MH) or GST state code (27).
- Customers outside the home state, and suppliers, are placed in the larger commercial states.
- UAE: an emirate (DU, AZ, SH, AJ, RK, FU, UQ) or its name.
- Germany: a Bundesland (BY, BE, HH, NW, BW, HE, NI, SN, RP, SH) or its name.
- US: only TX.
- Most customers are in the home state; suppliers are spread wider, as for a real business.
A site that is already in use
If the site already has transactions, install stops and explains:
bench --site demo.localhost demo-gen install --country IN
This site already has transactions:
Kaveri Traders (default company): 42 documents, 180 GL entries
The demo goes into a new, separate company (a peer, not a child company) and
does not change these. It becomes the default company while installed;
uninstall deletes it and restores the current default.
This is safe, but because the site is in use, installing needs --force.
bench --site demo.localhost demo-gen install --country IN --force
--forceis also needed when the GST API is on (India), or with--no-gst.
Stop and resume
bench --site demo.localhost demo-gen install --country US --size large
# ... press Ctrl+C, or the machine restarts ...
bench --site demo.localhost demo-gen install --country US --size large
# The same command resumes where it stopped.
See every document created
bench --site demo.localhost demo-gen install --country AE --verbose
# At the end, prints how many documents of each doctype were created.
Every document is also recorded in the Demo Data Record list, under its Demo Data Run. Uninstall uses that record, together with ERPNext's Transaction Deletion Record.
Remove one run of several
bench --site demo.localhost demo-gen uninstall --run DD-RUN-00009
- Without
--run, uninstall removes the only active run. verify --run DD-RUN-00009checks one run the same way.
Put the demo into your own company
By default the demo gets a new company. --use-wizard-company uses the company
made by the setup wizard instead:
```bash bench --site demo.localhost demo-gen install --country DE --use-wizard-company
Adds the demo's documents to your default company.
--force is needed only if that company already has transactions.
bench --site demo.localhost demo-gen uninstall
Backs up the site first, as bench drop-site does.
Then removes only the demo's documents, one by one.
Keeps (and lists) any demo document that your own documents re
Related Localization apps for Frappe & ERPNext
- Wiki — Free and Open Source Wiki built on top of Frappe
- India Compliance — Simple, yet powerful compliance solutions for Indian businesses
- Nepal Compliance — Open source ERP for Nepal with HR, Payroll & Accounting compliance, based on ERPNext by Frappe Technologies.
- Kamra Pms — World's first open-source, agentic AI-ready PMS. Free hotel and short-term rental PMS (AGPL): front desk, folios, POS, housekeeping, booking engine, plus governed MCP so Claude can run the property. Built on Frappe v16.
- Erpnextswiss — ERPNext application for Switzerland-specific use cases
- Erpnext Germany — ERPNext customizations for German companies
- Ksa Compliance — KSA Compliance App for KSA E-invoice
- Zatca Erpgulf — Implementation of Zatca Phase-2 E-Invoicing - for FrappeCLoud