BenchPress Documentation

BenchPress Documentation

Open in ChatGPT
Ask ChatGPT about this page
Open in Claude
Ask Claude about this page

BenchPress documentation

BenchPress documentation

BenchPress deploys a Frappe bench from a template. An operator describes the
bench once. Anybody with access deploys it, works in it, and destroys it when
the task is done.

Who this is for. Three readers, three tracks. Read the track that matches
your job. You do not need the other two.

Tracks

Track Read it when Start at
User Somebody gave you a login and you need a bench Quick tour
Operator You run the server that hosts the benches Operator track
Reference You call the API or change the code Reference track

All three tracks are published. Forty pages in total: 12 for a user, 16 for an
operator, 11 for reference, and this one.

What BenchPress does

An operator describes a lab once: a Frappe version and a list of apps. A
deploy turns that lab into a running bench instance. The deploy restores a
cached image, creates a site, and puts the container on a WireGuard network.

You get a site address, an SSH login and a browser VS Code session. When the
work is done, you destroy the environment. Spin up, use, tear down.

No bench is on the public internet. Every site, SSH port and IDE session is
reachable only from a device that joined the VPN.

Reference

One MDX source builds three surfaces. The leadtype pipeline writes all three.

Surface Path Read by
Rendered pages docs-site/docs/** a person
Offline index docs-bundle/AGENTS.md a coding agent with a clone
Routing hints docs-site/llms.txt an agent over HTTP

Rebuild every surface with one command:

npm run docs:build && npm run docs:lint && npm run docs:score

Every page states in prose whatever its screenshots show. Strip the images and
the page is still complete.

  • Quick tour — the five screens, and what the dashboard reports.
Last updated 4 hours ago
Was this helpful?
Thanks!