Usage¶
Development¶
Runs the Hono API and Vite dev server together; the UI proxies /api to the API port.
- Open the URL Vite prints (commonly
http://127.0.0.1:5173). - The API listens on
127.0.0.1:$PI_PORTAL_API_PORT(default 8790). See Configuration.
Under Files, tabs for optional paths (APPEND_SYSTEM.md, AGENT.md, workspace.conf) appear only when that file exists on disk, or after you use Add optional file to create one.
URL hash (refresh and deep links)¶
The UI syncs to the fragment so refresh restores the selected agent, main section (Files / Extensions / Skills), and file tab when you are on Files.
Examples:
#/— no agent selected#/agent/my-agent/extensions— Extensions formy-agent#/agent/my-agent/files/pi-args— Files editor onpi-args
Segments are URL-encoded. Unknown agents in the hash show an error and reset the hash to #/.
Production (single process)¶
Build the SPA, then start the server with static serving enabled:
Open http://127.0.0.1:8790 (or your chosen PI_PORTAL_API_PORT).
npm scripts¶
| Script | Purpose |
|---|---|
npm run dev |
tsx watch server.ts + Vite (concurrent) |
npm run build |
Typecheck + Vite production build |
npm start |
API + static dist/ when PI_PORTAL_SERVE_STATIC=1 |
npm run check |
tsc --noEmit |