agentleFS
AlbertoVasquezRAlbertoVasquezR/panal/AGENTS.md

panal

AGENTS.md1 starsChanged 45 days agoApache-2.0View on GitHub

Claude Code, Codex, opencode and any other agent working here reads this file. Read it before making changes. Panal (panal, Go, Bubble Tea) is a read-only terminal dashboard of what opencode, codex, agy and Claude Code as orchestrator are doing, plus panal delegate (hands tasks to those CLIs with quota fallback) and a router (-c auto) that learns which agent, model and effort fits each task. Overview: README.md; guides: docs/; structure: docs/ARCHITECTURE.md. 1. Work only inside this repository (or its…

  • Installs packages
  • Commits and pushes
  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 33,315 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository4 other files it gives its agents.

The file

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

5 rules. About 0 are common, 2 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Don't edit or commit to any other project of the user, including the repo where delegar.sh lives.

    line 18
  2. Very specific:

    Golden screens are reviewed: After -update, read the diff: only the intended change may appear.

    line 86
  3. Distinctive:

    No personal data; no AI attribution in commits.

    line 110
  4. Very specific:

    Before touching internal/ui or internal/mascots, read .claude/skills/panal-ux/SKILL.md: palette, status glyphs, mascot and animation rules, …

    line 115
  5. Distinctive:

    Read it when you pick the project back up, and add an entry when you finish a work session.

    line 124

≈ “Common” is an estimate: at least 1 in 5 of the 42,283 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

Rules for agents in this project

Claude Code, Codex, opencode and any other agent working here reads this file. Read it before making changes.

What it is

Panal (panal, Go, Bubble Tea) is a read-only terminal dashboard of what opencode, codex, agy and Claude Code as orchestrator are doing, plus panal delegate (hands tasks to those CLIs with quota fallback) and a router (-c auto) that learns which agent, model and effort fits each task. Overview: README.md; guides: docs/; structure: docs/ARCHITECTURE.md.

Rules

  1. Work only inside this repository (or its git worktrees). Don't edit or commit to any other project of the user, including the repo where delegar.sh lives. If an improvement would need a change outside this repo, solve it on the dashboard's side, or tell the user and stop.
  2. The repo is public at https://github.com/AlbertoVasquezR/panal (module github.com/AlbertoVasquezR/panal). Local commits on master (or on the worktree's branch) are fine; git push, pull requests, tags and releases only when the user asks for them.
  3. Because it is public, never put personal paths, email addresses, tokens or names of work projects in code, tests or docs.
  4. No Co-Authored-By or any other AI attribution in commit messages.
  5. English everywhere: code, identifiers, comments, UI text, commit messages and docs. The product name is Panal in prose and on screen; the command, binary, module, flags, file names and config keys stay panal.

Commands

go build ./...
go vet ./...
go test ./...
gofmt -l .                                      # must print nothing
go test ./internal/ui -run TestScreens -update  # regenerate golden screens, then read the diff
go run ./cmd/panal -preview 100                 # one screen at 100 columns (add -screen history, …)
go run ./cmd/panal -doctor                      # sources found, what was read, models
go install ./cmd/panal                          # installs the binary to ~/go/bin

Repo map

pathowns
cmd/panalflags and subcommand dispatch
cmd/previewevery mascot frame to a PNG
internal/statethe shared Row, Status, Quota
internal/readersone reader per agent; read-only; real samples in testdata/
internal/livelive quota queries to the CLIs (no turn, no quota spent)
internal/runsrun file format and ~/.panal paths; legacy.go reads the delegar.sh format
internal/historypast runs with tokens, cost, ratings, full tasks
internal/delegatethe delegate, route and models commands; each CLI's command line; quota patterns
internal/routertier rules, outcomes, posteriors, Thompson choice, external router
internal/modelsmodel discovery, models.json, cost heuristic, pool = auto
internal/feedbackpanal feedback and feedback.json
internal/changeswhat a run really touched (git, read-only)
internal/activitylast action, loops and tests from a log tail
internal/credits, internal/forecastcodex credits; when a quota runs out
internal/reporttask types, -report, -summary
internal/remote-serve and other machines
internal/configpanal.conf; which agents are off
internal/alertsnotifications, bell, ntfy, webhooks
internal/mascots, internal/uisprites; Bubble Tea views and keys
internal/petpanal pet: the mascot for a split pane and its JSON frame contract (docs/reference.md#pet-frames)
plugins/panal-pet, .claude-plugin/marketplace.jsonthe Claude Code plugin that draws panal pet -stream frames above the prompt (TypeScript hooks module; check with claude plugin validate)

Invariants

  • The dashboard is read-only. Panal never writes to the agents' files. It writes only its own files under ~/.panal (PANAL_DATA): run files and logs, samples.json, feedback.json, router-checks.json, models.json.
  • External formats keep their names. JSON keys, paths and values that belong to codex, agy, opencode or Claude Code are never renamed.
  • The legacy delegar.sh format (Spanish keys) is read only in internal/runs/legacy.go.
  • Spanish only where allowed: internal/runs/legacy.go, regex patterns that match tasks written in Spanish (each one says so), and real captured output in testdata/.
  • No real agents in tests. Fakes only (the test binary as a fake CLI, real captured outputs); never spend quota.
  • Golden screens are reviewed. After -update, read the diff: only the intended change may appear.
  • The router stays explainable. Tier rules live in one table with names that panal route prints; Thompson sampling is seeded in tests.

Where to change X

to…changeand also
read a new agenta reader in internal/readers (implements Reader), added to All() and Sources()real samples in testdata/; a color and a mascot (read the UX skill first)
run a new CLI from panal delegateagents in internal/delegate/agents.go, its patterns in classify.go, DefaultCLIs in chain.goa fake in fake_test.go; config.Known; discovery in internal/models/discover.go
add a keythe view's key switch in internal/ui/ui.go, the help in help.go, the footerdocs/dashboard.md#keys; golden help screens
add a router tier ruletierRules in internal/router/tier.gotests in English and Spanish in tier_test.go; the table in docs/router.md
change outcomes or priorsinternal/router/evidence.go, posterior.goseeded learning tests; the numbers in docs/router.md
add a config keyConf and Read in internal/config/config.godocs/configuration.md
add a run file fieldruns.Run in internal/runs/runs.go (with omitempty)docs/reference.md#run-files

Definition of done

  • gofmt -l . prints nothing; go build ./..., go vet ./... and go test ./... pass.
  • New behavior has tests; UI changes have reviewed golden diffs.
  • The docs in docs/ (and the README, if it is user-facing) say what the code does; every command, flag, key and path they mention exists.
  • No personal data; no AI attribution in commits.
  • An entry in docs/JOURNAL.md when you finish a work session.

UI design

Before touching internal/ui or internal/mascots, read .claude/skills/panal-ux/SKILL.md: palette, status glyphs, mascot and animation rules, sizes and checklist. For general TUI principles there is .claude/skills/tui-design/ (a copy of gfargo/tui-design-skill). What is left from the last UX audit is in docs/ux-audit.md.

History

What was done, why, what was learned and what is pending: docs/JOURNAL.md. Read it when you pick the project back up, and add an entry when you finish a work session.

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.