PgArachne Explorer
The Explorer is a powerful web GUI included in the tools/pgarachne-explorer directory. It is not
just documentation; it is a fully functional demo application built using HTML/JS
that communicates with the database exclusively via PgArachne. You can also use the hosted version at
explorer.pgarachne.com.
What can it do?
- Inspect API: It reads the
capabilitiesfunction to display all available endpoints and their parameters. - Live Testing: You can execute functions directly from the browser.
- Auto-Documentation: It renders the SQL comments (including
--- PARAMS ---metadata) into readable documentation. - Modern UI: Features Dark/Light mode support and can be installed as a PWA on mobile devices.
URL Parameters:
You can pre-fill the connection settings using the ?url= parameter, for example:
?url=http://localhost:8080/db/my_database. This will automatically split the URL into API Host, Prefix, and Database fields.
How to enable it: Set the
STATIC_FILES_PATH environment variable to point to the
tools/pgarachne-explorer folder on your disk. Then visit http://localhost:8080.