agentleFS
BlackBeltTechnologyBlackBeltTechnology/pi-agent-dashboard/AGENTS.md

pi-agent-dashboard

AGENTS.md349 starsChanged 23 days agoMITView on GitHub

Web dashboard to monitor + control pi agent sessions remotely. Three components: bridge extension + Node server + React client. Full architecture: docs/architecture.md. The kb-first READ doctrine is injected per turn by the kb extension. Two repo-specific pointers the canonical doctrine leaves out: Behavioral guidelines to reduce common LLM mistakes. Bias toward caution over speed. Trivial tasks → judgment. The generic WRITE discipline (doc routing, the | File | Purpose | row schema, the size-split rule, root-lean) is injected per…

  • Reads credentials
  • Installs packages

The file

We split this AGENTS.md into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use Mermaid (```mermaid blocks), not ASCII box drawings — explore mode, design docs, all artifacts.

    line 111

≈ “Common” is an estimate: at least 1 in 5 of the 41,581 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

PI Dashboard

Web dashboard to monitor + control pi agent sessions remotely. Three components: bridge extension + Node server + React client. Full architecture: docs/architecture.md.

Retrieval pointers (repo-specific)

The kb-first READ doctrine is injected per turn by the kb extension. Two repo-specific pointers the canonical doctrine leaves out:

  • build / run / install / setup / release / "how do I X" → grep -i <kw> docs/faq.md README.md docs/ — then quote.
  • reproduce the kb retrieval-quality numbers → tsx packages/kb/eval/run-fixtures.ts.

Code Instructions (per-turn doctrine)

Behavioral guidelines to reduce common LLM mistakes. Bias toward caution over speed. Trivial tasks → judgment.

  1. Think before coding. State assumptions; if uncertain, ask via ask_user. Present multiple interpretations, don't pick silently. Push back when a simpler approach exists. Never speculate about code you haven't opened. Confirm the plan before any major change.
  2. Simplicity first. Minimum code that solves the problem. No speculative features/abstractions/flexibility/error-handling for impossible cases. DRY: extract a shared helper when a pattern repeats (not for a single call site). "Would a senior engineer call this overcomplicated?" If yes, simplify.
  3. Surgical changes. Touch only what you must. Don't improve/refactor/reformat adjacent code. Match existing style. Mention unrelated dead code, don't delete it. Remove only orphans YOUR change created. Every changed line traces to the request.
  4. Goal-driven (TDD). Turn tasks into verifiable goals. Write/update tests first, verify they fail, then minimal implementation to pass. State a brief plan for multi-step tasks (step → verify).
  5. Communication. High-level summary of what changed each step. Use ask_user (not plain text) for clarification/choices.

Docs delegation (project-specific)

The generic WRITE discipline (doc routing, the | File | Purpose | row schema, the size-split rule, root-lean) is injected per turn. Repo-specific additions:

  • Every write under docs/ (prose AND docs/AGENTS.md) is delegated to a general-purpose subagent (DocScribe) with the caveman-style rule passed verbatim — short declarative fragments, drop articles/copulas, subject→verb→object, one fact per line, concrete tokens (paths/fns/env/ports) over prose, symbols verbatim. Main agent orchestrates, never edits docs/ directly. Source-tree rows under packages/ + non-source areas: main agent edits directly.
  • Source-of-truth change the doctor skill derives → doctor --regenerate <module> — never hand-maintain version/name tables.

Architecture

Full details: docs/architecture.md. Electron bootstrap: docs/electron-bootstrap-flow.md. Doctor skill: docs/doctor-skill.md.

  • Bridge Extension (packages/extension/src/) — runs in every pi session, forwards events via WebSocket
  • Dashboard Server (packages/server/src/) — aggregates events, in-memory + JSON persistence, dual WebSocket servers
  • Web Client (packages/client/src/) — React + Tailwind responsive UI
  • Shared Types (packages/shared/src/) — protocol definitions

Commands

pnpm install         # deps — pnpm ONLY (pnpm-workspace.yaml sets nodeLinker: hoisted); `npm install` drifts the tree
npm test             # all tests (vitest)
npm run build        # build web client (Vite)
npm run dev          # Vite dev server
npm run reload       # reload all connected pi sessions
pi-dashboard         # start server   (--dev = Vite proxy)

Docker (self-contained all-in-one: server + pi + code-server + zrok + tmux). Full guide: docker/README.md; per-file map: docker/AGENTS.md.

cd docker && cp .env.example .env && docker compose up -d --build
PI_WORKSPACES="/abs/a:/abs/b" ./up.sh

Running Tests

Pipe once to a tmp file, then grep — never rerun to inspect errors. Keep pipefail + the summary pattern: without them a failing run reports exit 0 and leaves no verdict in the transcript.

set -o pipefail; npm test 2>&1 | tee /tmp/pi-test.log
grep -nE 'FAIL|Error|✗|✘|Tests +[0-9]+ (failed|passed)' /tmp/pi-test.log

Build & Restart Workflow

Rebuild/restart procedure — extension→reload, server→restart, client→build+restart, openspec-apply→full rebuild — plus the code discipline for landing a change: the implement skill (auto-loads on "rebuild", "after edit", "implement X", "how do I land this"). Two-tier code review (review-code inline + opt-in CodeRabbit ship gate), Biome quality ratchet (code-quality skill, npm run quality:changed), and the discipline-skill checkpoint table also live there. Full quality ref: docs/code-quality.md.

Quick reference:

npm run reload                              # after packages/extension/ changes
npx tsx .pi/skills/implement/scripts/restart-server.ts   # after packages/server|packages/shared changes (jiti — no build; mints local proof)
npm run build && npx tsx .pi/skills/implement/scripts/restart-server.ts   # after packages/client changes (production)
curl -s http://localhost:8000/api/health | jq .mode   # dev | production

/api/restart is the single restart source of truth (CLI restart delegates to it when the dashboard is up). --dev proxies to Vite with automatic production fallback. full-rebuild.ts = deploy checked-out dev to the local instance; NOT a feature step.

Cross-Platform QA

Two additive layers: VM smoke (qa/, clean-install + runtime per OS) and Playwright browser E2E (tests/e2e/, rendered-UI behaviour vs the docker harness). New browser scenarios → Playwright specs, NOT qa/tests/*.sh. Full setup: qa/README.md. E2E is opt-in (npm run test:e2e); harness lifecycle via docker/test-up.sh/test-down.sh.

Subagent Routing

Delegate specialist work to the matching subagent (isolated context). Explicit Agent call with subagent_type required (skills auto-load by NL; subagents don't). One specialist per task; skip for trivial edits.

SubagentUse for
ExploreRead-only search / "where is X" when the tree misses (per-file lookups use kb agents directly).
react-expertReact refactors/hooks/state/render-perf in packages/client/, packages/*-plugin/src/client/.
typescript-expertType-system, generics, strict-mode, async typing, .d.ts.
nodejs-expertServer async/streams/perf in packages/server/, packages/extension/, packages/electron/ main.
tailwind-expertUtility-class refactors, breakpoints, tokens, dark-mode.
AuditDeep security+perf pass on a diff (read-only findings; parent fixes).
DocScribeWrite docs/ prose in caveman style (Rule-6 target). Returns tree rows for parent to apply.
SessionGuidelineTurn a session into a how-we-did-it playbook.

Apply-loop spawn checkpoints (signal in diff/tasks.md → spawn): touches auth/secrets/PII/untrusted-input/webhooks or a latency budget → Audit; contextFiles list large → Explore; a change landed + docs/ needs prose → DocScribe; ≥3 React components touched, or a hook added/reworked, or a render-perf fix → react-expert; ≥3 server modules touched, or new async/stream/WS path → nodejs-expert.

Discipline-skill checkpoints (invoke the eng-disciplines skill when the signal appears): auth/untrusted-input/secrets/PII → security-hardening; latency/throughput budget or large-data path → performance-optimization; new endpoint/job/external-call → observability-instrumentation; irreversible step (migration/public-API) before it stands → doubt-driven-review; bug mid-implementation → systematic-debugging; opaque runtime state (jiti/PTY/WS) → node-inspect-debugger; non-trivial change + tests pass before commit → review-code; works but feels heavy → code-simplification.

Mock routing: any mock / mockup / UI-option / variant request → load the frontend-mockup-loop-dashboard skill (live-component mocks on the mock site; never off-loop static HTML).

Context inheritance: this repo ships pi-dashboard-subagents (default inheritContext: true → child gets a compressed parent snapshot, capped by maxChars). Still pass exact file paths + the question in task:; use Explore first if locations are unknown.

OpenSpec Conventions

In a worktree, resolve OpenSpec skills from the main repo root, not the checkout. Create change artifacts at openspec/changes/<name>/ (never under active//archive/); prefer openspec change new <name>. Creation-time only — ship-change MOVES a completed change into openspec/changes/archive/<date>-<name>/, which scripts/check-conventions.mjs skips as immutable history; a review asking to move an archived change back is a false positive. In proposal.md, add a ## Discipline Skills section naming the eng-disciplines skills its tasks trigger (per the checkpoint tables above); when none apply, say so under the heading rather than omitting it. Gating on any proposal.md a change touches (ship-it step 4.4 via scripts/check-conventions.mjs); untouched proposals are not backfilled. Use ask_user (batch for multi-question) for any needed input.

Diagram Style

Use Mermaid (```mermaid blocks), not ASCII box drawings — explore mode, design docs, all artifacts.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.