agentleFS
NovusEdgeNovusEdge/docket/docs/agents.md

docket

AGENTS.md2 starsChanged 2 months agoMITView on GitHub

You can ask your agent to record a decision, look up an earlier choice, or list the questions that still need answers. Docket keeps those records available across sessions. Use the setup prompt to let your agent install Docket and configure its integration. If you prefer manual setup, the installation guide has a route for Claude Code, Codex, Gemini CLI, GitHub Copilot CLI, Cursor, and OpenCode. After setup, start a new session in your project. Ask: Read the Docket context…

  • 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,774 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 repository3 other files it gives its agents.

The file

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

7 rules. About 0 are common, 4 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    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:

    Use the setup prompt to let your agent install Docket and configure its integration.

    line 9
  2. Distinctive:

    After setup, start a new session in your project.

    line 14
  3. Distinctive:

    Before a new task, ask:

    line 51
  4. Distinctive:

    When a feature is open on the current branch, the briefing names it above the record selection: its slug, state, and declared intent, then …

    line 72
  5. Distinctive:

    After compaction or a long break, ask the agent to read the context again.

    line 78
  6. Very specific:

    If the command works in your terminal but the agent receives no briefing, start a new session and check its integration setup.

    line 104
  7. Very specific:

    Use --decided-by when the decision owner is someone else.

    line 114

≈ “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

Working with your agent

You can ask your agent to record a decision, look up an earlier choice, or list the questions that still need answers. Docket keeps those records available across sessions.

Connect your agent

Use the setup prompt to let your agent install Docket and configure its integration. If you prefer manual setup, the installation guide has a route for Claude Code, Codex, Gemini CLI, GitHub Copilot CLI, Cursor, and OpenCode.

After setup, start a new session in your project. Ask:

Read the Docket context for this project and tell me which questions are still open.

The integration loads a briefing and gives the agent instructions for using Docket. If you prefer to configure it yourself, use the agent setup reference.

Different agent tools can use the same project ledger when they run in the same checkout. To share records with another checkout or computer, commit and sync .docket/ through Git.

Ask for a record when a choice is made

You can say:

Record that billing will use Postgres because we already operate it. Scope the decision to billing/**.

Give the agent the choice and the reason you want preserved. It can then record them with the Docket command.

For an unresolved issue:

Leave an open question about which database driver billing should use.

For a change of direction:

Replace the earlier driver decision with asyncpg and record why we changed it. Keep it linked to the question it answers.

The agent should use --supersedes to preserve the earlier record. You can inspect what it recorded with docket list and docket show ID.

Start work with the relevant context

Before a new task, ask:

Read the Docket context for billing and check the open questions before making changes.

For a more specific briefing, you or your agent can run:

docket context --query "billing database" --file billing/db.py
<!-- TODO(screenshot): a real agent session where the session hook has loaded a briefing, with the record block and the selection line visible. This is the product working end to end, and no doc page shows it. Redact the project path. -->

The briefing distinguishes a recorded choice from a claim that may need review. An accepted claim still needs fresh checking when its evidence could have changed.

When a feature is open on the current branch, the briefing names it above the record selection: its slug, state, and declared intent, then its highest-ranked attached records. The header draws from the same character budget as the rest of the briefing, so it takes a bounded share rather than a fixed count. See Feature tracking.

After compaction or a long break, ask the agent to read the context again. The integration's refresh behavior depends on the agent tool, and a briefing already loaded into a conversation does not update itself.

When a decision is missing

First, check that the record exists in the active ledger:

docket where
docket list --find billing

Then request a focused briefing:

docket context --query "billing" --file billing/db.py

A record may appear in the index rather than in full. Ask the agent to retrieve it by ID. If it does not appear at all, check the ledger location and whether the record's wording or scope matches the task.

To change a scope, record a replacement with --supersedes. To inspect a record immediately, use docket show ID --json without changing the ledger.

If the command works in your terminal but the agent receives no briefing, start a new session and check its integration setup. If the command itself fails, run docket check and see Maintenance.

Know who recorded a choice

Docket records an author and includes session and branch information when available. These describe who recorded the entry; they do not establish who approved the choice.

Use --decided-by when the decision owner is someone else. This is recorded attribution, not an authenticated identity.

For the hook formats and instruction files, see Agent setup reference. For how a briefing is selected, see Bounded context.

Recording and feature skills

skills/docket/SKILL.md covers recording: claims, decisions, and questions. skills/docket-feature/SKILL.md covers a piece of work in flight: starting it, resuming it with docket feature brief, and closing it with docket feature done. The harness selects between them on each skill's description, so a task that only records a decision never loads feature guidance, and a task that starts or resumes a feature never loads the recording skill unless it also records something.

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.