agentleFS
Sign inStart free
NaorayNaoray/scribe/AGENTS.md

scribe

AGENTS.md6 starsChanged 7 months agoMITView on GitHub

cmd/ contains CLI entrypoints and Bubble Tea TUIs, including the main binary at cmd/scribe. Core application logic lives under internal/, split by concern such as internal/workflow, internal/sync, internal/state, internal/tools, and internal/provider. User-facing docs and design notes live in docs/. Sample or local agent assets may exist under agents/, but production code should stay in cmd/ or internal/. Use standard Go formatting and keep code gofmt-clean. Prefer small functions, explicit error handling, and package-local helpers over cross-package shortcuts. Keep package names…

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

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    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:

    Write table-driven Go tests where practical.

    line 21
  2. Very specific:

    Follow the repo’s history: short imperative commit subjects such as fix: preserve tools on list TUI updates or perf: lazy-init command …

    line 25
  3. Very specific:

    Do not read from or modify files outside this repository worktree unless the user explicitly asks for it.

    line 29

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

Repository Guidelines

Project Structure & Module Organization

cmd/ contains CLI entrypoints and Bubble Tea TUIs, including the main binary at cmd/scribe. Core application logic lives under internal/, split by concern such as internal/workflow, internal/sync, internal/state, internal/tools, and internal/provider. User-facing docs and design notes live in docs/. Sample or local agent assets may exist under agents/, but production code should stay in cmd/ or internal/.

Build, Test, and Development Commands

  • go build ./... builds all packages and catches compile-time regressions.
  • go test ./... runs the full test suite.
  • go test ./internal/workflow ./internal/sync ./cmd is a good focused pass for command and sync changes.
  • go run ./cmd/scribe --help runs the CLI locally.
  • go run ./cmd/scribe list --json is a quick smoke test for non-TTY output.

Coding Style & Naming Conventions

Use standard Go formatting and keep code gofmt-clean. Prefer small functions, explicit error handling, and package-local helpers over cross-package shortcuts. Keep package names lowercase and file names descriptive, for example list_tui.go or syncer.go. Cobra commands should follow the existing newXCommand and runX pattern. Tests should sit next to the code they cover.

Testing Guidelines

Write table-driven Go tests where practical. Name tests with TestXxx and keep them close to the changed package. Cover behavior changes, not just happy paths; TUI and workflow regressions should include command-path tests when possible. Run go test ./... before committing.

Commit & Pull Request Guidelines

Follow the repo’s history: short imperative commit subjects such as fix: preserve tools on list TUI updates or perf: lazy-init command dependencies. Prefer focused commits over mixed refactors. PRs should explain the user-visible change, note risks or migration impact, and include terminal output or screenshots when changing TUI behavior.

Agent-Specific Instructions

Do not read from or modify files outside this repository worktree unless the user explicitly asks for it. Treat external paths such as ~/.scribe/ as off-limits by default.

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