sledtoolssledtools/pika/AGENTS.md

pika

AGENTS.md45 starsChanged 8 months agoMITView on GitHub

Run ./scripts/agent-brief once at the start of each new agent session in this worktree (not every turn). Rerun only if asked, if you switch worktrees, or if the first run failed. For this project, canonical Git lives on git.pikachat.org. Prefer pushing branches to the forge remote and using ph for agent-facing forge actions like status, wait, logs, merge, and close. Do not silently rename remotes or rewrite a user's remote layout unless they explicitly ask; if the current remote setup…

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 31,439 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 repository7 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- jetpack-compose-material3-expert-skillSkill
- landSkill
- orchestrateSkill
- swiftui-expert-skillSkill
- e2e-videoSkill
- pr-shepherdSkill

The file

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

10 rules. About 0 are common, 1 is distinctive, and 9 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.
9
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific
could be automatic: a setting could enforce it

Very specific:
Run ./scripts/agent-brief once at the start of each new agent session in this worktree (not every turn).
line 1
Very specific:
Do not silently rename remotes or rewrite a user's remote layout unless they explicitly ask.
line 6
Very specific:
Use just checks::pre-commit-full only when you want the slower richer local follow-up tier.
line 22
Very specific:
Run cargo fmt to format Rust code before committing.
line 23
Distinctive:
Always add tests for changes when possible.
line 24
Very specific:
Use ph for forge interaction where appropriate: ph status, ph wait, ph logs, ph merge, ph close.
line 30
Very specific:
Treat the visible root just surface as curated for humans.
line 34
Very specific:
Put real implementation in scripts/ or a dedicated CLI.
line 35
Very specific:
Default low-signal, manual, debug, and compatibility helpers to module-local recipes and usually mark them [private].
line 36
Very specific:
Treat ./scripts/agent-brief as the supported expanded discovery path for agents.
line 37

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

Run ./scripts/agent-brief once at the start of each new agent session in this worktree (not every turn). Rerun only if asked, if you switch worktrees, or if the first run failed.

For this project, canonical Git lives on git.pikachat.org. Prefer pushing branches to the forge remote and using ph for agent-facing forge actions like status, wait, logs, merge, and close. Do not silently rename remotes or rewrite a user's remote layout unless they explicitly ask; if the current remote setup is not forge-native, call it out and recommend using origin for git@git.pikachat.org:pika.git.

Related codebases

Repo	Description
`sledtools/pika`	This repo. iOS + Android app, Rust core, pikachat CLI.
`marmot-protocol/mdk`	Marmot Development Kit. Rust MLS library used by pika.
`openclaw/openclaw`	OpenClaw gateway. The bot framework that hosts the pikachat plugin.
`justinmoon/infra`	NixOS configs for public MoQ relays and other infrastructure.

Before committing

On substantive code/config changes, run just pre-commit before handoff or commit. This is the repo's canonical fast local smoke command.
Use just checks::pre-commit-full only when you want the slower richer local follow-up tier.
Run cargo fmt to format Rust code before committing.
Always add tests for changes when possible.

Forge Workflow

Canonical Git and the forge web UI now live on git.pikachat.org.
Push branches to git@git.pikachat.org:pika.git.
Use ph for forge interaction where appropriate: ph status, ph wait, ph logs, ph merge, ph close.

Just Command Contract

Treat the visible root just surface as curated for humans; new root recipes should be rare and high-signal.
Put real implementation in scripts/ or a dedicated CLI; just recipes should usually be thin wrappers.
Default low-signal, manual, debug, and compatibility helpers to module-local recipes and usually mark them [private].
Treat ./scripts/agent-brief as the supported expanded discovery path for agents.
See docs/just-command-contract.md before adding or reorganizing just recipes.

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.

Check your setup, free