agentleFS
Sign inStart free
GabeDuarteMGabeDuarteM/blocky-ui/AGENTS.md

blocky-ui

AGENTS.md132 starsChanged 2 months agoMITView on GitHub

Blocky UI is a dashboard for the Blocky DNS proxy. Use Bun for package management and scripts. Changes to a query log provider or shared log code must preserve compatibility across all supported providers. For every such change, run the full log test suite with bun run test src/server/logs, including the integration tests in src/server/logs/__tests__/. The integration suite uses testcontainers with real databases and requires Docker or Podman. Verify that the change works across providers, including those you did not…

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

The file

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

7 rules. About 0 are common, 2 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    After code changes, run bun run verify and resolve failures introduced by the change.

    line 7
  2. Very specific:

    Run the tests relevant to changed behavior with bun run test <path>.

    line 8
  3. Very specific:

    Prefer inferred types. Use unknown instead of any when the type is unknown.

    line 18
  4. Very specific:

    Do not use non-null assertions (!) or type casting to bypass errors.

    line 19
  5. Distinctive:

    Use Tailwind classes for styling.

    line 20
  6. Distinctive:

    Prefer Drizzle query builders.

    line 21
  7. Very specific:

    Ask before editing existing components in src/components/ui/.

    line 25

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

Blocky UI

Blocky UI is a dashboard for the Blocky DNS proxy. Use Bun for package management and scripts.

Checks

  • After code changes, run bun run verify and resolve failures introduced by the change.
  • Run the tests relevant to changed behavior with bun run test <path>. This runs Vitest.

Provider compatibility

Changes to a query log provider or shared log code must preserve compatibility across all supported providers. For every such change, run the full log test suite with bun run test src/server/logs, including the integration tests in src/server/logs/__tests__/.

The integration suite uses testcontainers with real databases and requires Docker or Podman. Verify that the change works across providers, including those you did not modify.

Conventions

  • Prefer inferred types. Use unknown instead of any when the type is unknown.
  • Do not use non-null assertions (!) or type casting to bypass errors. Fix the types or narrow values instead.
  • Use Tailwind classes for styling.
  • Prefer Drizzle query builders; use raw SQL only when necessary.

Shared UI components

Ask before editing existing components in src/components/ui/. When shadcn provides a component, add it with the shadcn CLI. Preserve local customizations when adding or updating components.

Task references

  • Configuration changes: read blocky-ui.example.yml and src/env.js.
  • Changesets: follow .agents/skills/generate-changeset/SKILL.md.
<!-- BEGIN:nextjs-agent-rules -->

This is NOT the Next.js you know

This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in node_modules/next/dist/docs/ (resolved from this file's directory; in monorepos the next package may not be visible from the repo root) before writing any code. Heed deprecation notices.

This block is written and re-added by next dev — verify at node_modules/next/dist/server/lib/generate-agent-files.js. Removing it from a diff only re-creates the uncommitted change; committing it with your work keeps the tree clean.

<!-- END:nextjs-agent-rules -->

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