agentleFS
Sign inStart free
conversitionconversition/AgentX/AGENTS.md

AgentX

AGENTS.md0 starsChanged 15 months agoApache-2.0View on GitHub

  • Reads credentials

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 1

    1. lucky-aeon/AgentX★ 852100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • 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

4 rules. About 0 are common, 2 are distinctive, and 2 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.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Distinctive:

    Run linters/formatters before pushing.

    line 24
  2. Very specific:

    Use Conventional Commits: feat(scope): ..., fix(scope): ..., refactor: ..., docs: ..., chore: ....

    line 31
  3. Distinctive:

    Keep PRs small and focused.

    line 33
  4. Very specific:

    Prefer deploy/start.sh for a consistent local environment.

    line 37

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

  • AgentX — Spring Boot (Java 17) backend. Source in AgentX/src/main, tests in AgentX/src/test. Built with Maven Wrapper (./mvnw).
  • agentx-frontend-plus — Next.js 15 + TypeScript UI. App routes under app/, shared UI in components/.
  • Deployment & ops: deploy/ (Docker Compose scripts), docker/, docs/, config/, production/. Logs in logs/.

Build, Test, and Development Commands

  • Backend (from AgentX):
    • Build: ./mvnw -DskipTests package
    • Run (dev): ./mvnw spring-boot:run -Dspring-boot.run.profiles=dev
    • Test: ./mvnw test
    • Format: ./mvnw spotless:apply
  • Frontend (from agentx-frontend-plus):
    • Install deps: npm install (or pnpm install)
    • Dev server: npm run dev (http://localhost:3000)
    • Build/Start: npm run build && npm start
    • Lint: npm run lint
  • All‑in‑one (Docker): cd deploy && ./start.sh to spin up backend, frontend, DB, MQ.

Coding Style & Naming Conventions

  • Java (backend): formatted via Spotless using AgentX/eclipse-formatter.xml. 4‑space indent, PascalCase classes, camelCase methods/fields, packages start with org.xhy.*.
  • TypeScript/React (frontend): 2‑space indent, React components PascalCase, files kebab‑case (e.g., model-select-dialog.tsx). Keep hooks in hooks/, UI in components/.
  • Run linters/formatters before pushing; keep functions small and cohesive.

Testing Guidelines

  • Backend: JUnit via Spring Boot starter. Place tests under AgentX/src/test/java, name *Test.java. Run with ./mvnw test and target service/controller layers.
  • Frontend: No default test runner configured; for UI changes include a minimal test plan or interactive demo steps in the PR.

Commit & Pull Request Guidelines

  • Use Conventional Commits: feat(scope): ..., fix(scope): ..., refactor: ..., docs: ..., chore: ....
  • PRs include: clear description, linked issues (Fixes #123), test plan (commands + expected result), and screenshots/GIFs for UI.
  • Keep PRs small and focused; update docs when behavior changes.

Security & Configuration Tips

  • Copy .env.example to .env and set secure values (e.g., JWT_SECRET, admin and DB passwords). Never commit secrets.
  • Prefer deploy/start.sh for a consistent local environment. Review docs/deployment/ for production hardening.

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