agentleFS
wordbrickswordbricks/onequery/AGENTS.md

onequery

AGENTS.md17 starsChanged 6 months agoApache-2.0View on GitHub

If you encounter something surprising or confusing in this project, flag it as a comment.

The file

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

1 rule. About 0 are common, 1 is distinctive, and 0 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.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If you encounter something surprising or confusing in this project, flag it as a comment.

    line 1

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

If you encounter something surprising or confusing in this project, flag it as a comment.

  • Runtime: Node.js mostly, (Rust for apps/cli).
  • Contract: Connect RPC (Protobuf contracts locates at proto/)
  • Testing: Vitest
  • Linter/formatter: oxlint, oxfmt
  • For linting, use bun lint --format json. For type-aware lint, append --type-aware flag (takes more time then normal lint).
  • For checking lint/format for whole monorepo, use bunx turbo check --json, to fix, bunx turbo check:fix
  • For type checking, use bunx turbo typecheck --json.
  • For testing, use bunx turbo test --json, not bun test.
  • For tools, use mise exec.

Auto-generated files and how to generate them:

NOTE: Don't edit them manually.

  • packages/proto-cli/src/** - Generated by Buf from onequery/cli/v1
  • packages/proto-runtime/src/** - Generated by Buf from onequery/runtime/v1
  • packages/proto-workflow/src/** - Generated by Buf from onequery/workflow/v1
    • packages/cli-server/src/connect/** contains handwritten Connect handlers/adapters that import generated service descriptors from packages/proto-*.
  • apps/dashboard/src/routeTree.gen.ts - Generated by TanStack Router
  • **/worker-configuration.d.ts - Generated by Wrangler
  • packages/ui/src/components/ui/** - Generated by shadcn/ui CLI
  • packages/db/src/migrations/** - Generated by Drizzle CLI

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.