agentleFS
Sign inStart free
amalshajiamalshaji/agent-thread/AGENTS.md

agent-thread

AGENTS.md1 starsChanged 7 months agoMITView on GitHub

This repository is a Bun-managed Next.js/OpenNext app. Use Bun for project commands and dependency management, and keep changes aligned with the existing Next.js App Router and Cloudflare Worker deployment path. Use the narrowest meaningful verification for the change:

  • Reads credentials
  • 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,700 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 repositoryOne other file it gives its agents.

The file

Show its rules and text

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

14 rules. About 0 are common, 5 are distinctive, and 9 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    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
  1. Very specific:

    Use bun install instead of npm install, yarn install, or pnpm install.

    line 9
  2. Very specific:

    Use bun test for tests.

    line 11
  3. Very specific:

    Use bunx <package> <command> instead of npx <package> <command>.

    line 12
  4. Distinctive:

    Do not introduce Vite, Express, Jest, Vitest, npm, yarn, or pnpm.

    line 13
  5. Very specific:

    When a dependency exposes a Node-oriented CLI, invoke it through Bun, matching the existing scripts.

    line 14
  6. Very specific:

    Run the Next.js dev server: bun run dev

    line 20
  7. Very specific:

    Run the local CLI entrypoint: bun run cli

    line 27
  8. Very specific:

    When updating the CLI version, title the pull request Release cli {version}, replacing {version} with the exact version being released.

    line 31
  9. Very specific:

    Keep next.config.ts compatible with the OpenNext build path, including output: "standalone", unless the deployment strategy is …

    line 37
  10. Distinctive:

    Keep server-side rendering and public transcript rendering in the Next app rather than reintroducing a separate Bun.serve frontend.

    line 38
  11. Distinctive:

    Keep Cloudflare bindings and runtime-specific code isolated behind the existing helper modules.

    line 39
  12. Distinctive:

    Prefer existing local patterns over introducing new abstractions.

    line 43
  13. Very specific:

    Use Bun APIs in Bun-only scripts when they fit, such as Bun.file, Bun.write, Bun.$, and bun:sqlite.

    line 44
  14. Distinctive:

    Use the narrowest meaningful verification for the change:

    line 51

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

Agent Instructions

This repository is a Bun-managed Next.js/OpenNext app. Use Bun for project commands and dependency management, and keep changes aligned with the existing Next.js App Router and Cloudflare Worker deployment path.

Tooling

  • Use bun install instead of npm install, yarn install, or pnpm install.
  • Use bun run <script> instead of npm run <script>, yarn run <script>, or pnpm run <script>.
  • Use bun test for tests.
  • Use bunx <package> <command> instead of npx <package> <command>.
  • Do not introduce Vite, Express, Jest, Vitest, npm, yarn, or pnpm.
  • When a dependency exposes a Node-oriented CLI, invoke it through Bun, matching the existing scripts. For example: bun --bun ./node_modules/next/dist/bin/next build.
  • Codex or editor host tooling may use its own configured Node runtime when that tool requires it, such as js_repl or browser automation. That exception does not justify adding Node setup, npm scripts, or a project-level Node workflow.

Project Commands

  • Install dependencies: bun install
  • Run the Next.js dev server: bun run dev
  • Build the app and CLI: bun run build
  • Build only the CLI: bun run build:cli
  • Preview the Cloudflare Worker: bun run preview
  • Deploy through OpenNext/Cloudflare: bun run deploy
  • Type-check: bun run check
  • Run tests: bun test
  • Run the local CLI entrypoint: bun run cli

Release Workflow

  • When updating the CLI version, title the pull request Release cli {version}, replacing {version} with the exact version being released.

Architecture

  • The frontend and API routes live in Next.js App Router.
  • The Cloudflare Worker is produced by @opennextjs/cloudflare; wrangler.toml points at .open-next/worker.js.
  • Keep next.config.ts compatible with the OpenNext build path, including output: "standalone", unless the deployment strategy is intentionally changed.
  • Keep server-side rendering and public transcript rendering in the Next app rather than reintroducing a separate Bun.serve frontend.
  • Keep Cloudflare bindings and runtime-specific code isolated behind the existing helper modules.

Code Style

  • Prefer existing local patterns over introducing new abstractions.
  • Use Bun APIs in Bun-only scripts when they fit, such as Bun.file, Bun.write, Bun.$, and bun:sqlite.
  • Node built-in imports such as node:path and node:fs/promises are acceptable where the existing runtime target needs them, including Next.js, OpenNext, Cloudflare compatibility, and the published CLI bundle.
  • The CLI bundle intentionally targets Node compatibility and may keep #!/usr/bin/env node.
  • Bun loads .env automatically; do not add dotenv.

Testing

Use the narrowest meaningful verification for the change:

  • bun test for behavior covered by tests.
  • bun run check for TypeScript and route typing.
  • bun run build when touching Next/OpenNext build behavior, deployment config, or the CLI bundle.

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