agentleFS
Sign inStart free
NVIDIAKnown publisherNVIDIA/nvcf/tools/AGENTS.md

nvcf / tools

AGENTS.md261 starsChanged 9 days agoApache-2.0View on GitHub

Scope: everything under tools/. - Put general executable wrapper scripts in tools/scripts/. - Put CI-focused entrypoint scripts in tools/ci/. - Put larger Go tools in their own directory under tools/, for example tools/collect-dependencies/ or tools/generate-subproject-ci/. - If a Go tool needs a stable repo entrypoint for CI or docs, add a thin wrapper in tools/ci/ or tools/scripts/ as appropriate, or document the exact go run or go build -C command.

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, 4 are distinctive, and 10 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 10

    Very specific

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

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

    Prefer bash for small repo-local wrappers, CI entrypoints, and scripts that mostly orchestrate existing CLI tools.

    line 7
  2. Very specific:

    Prefer Go for non-trivial tooling: structured parsing, manifest scanning, larger file transforms, concurrency, or logic that benefits from …

    line 8
  3. Very specific:

    Avoid adding new Python-based repo tooling when bash or Go is a reasonable fit.

    line 9
  4. Very specific:

    If Python is still required for a one-off command, use python3, not python.

    line 10
  5. Very specific:

    Put general executable wrapper scripts in tools/scripts/.

    line 14
  6. Very specific:

    Put CI-focused entrypoint scripts in tools/ci/.

    line 15
  7. Very specific:

    Put larger Go tools in their own directory under tools/, for example tools/collect-dependencies/ or tools/generate-subproject-ci/.

    line 16
  8. Very specific:

    If a Go tool needs a stable repo entrypoint for CI or docs, add a thin wrapper in tools/ci/ or tools/scripts/ as appropriate, or document …

    line 18
  9. Very specific:

    Use hyphens, not underscores, for filenames under tools/, especially under tools/scripts/.

    line 22
  10. Very specific:

    Keep test entrypoints aligned with the tool name, for example test-<tool-name>.

    line 24
  11. Distinctive:

    Keep tools easy to run in CI and local development.

    line 28
  12. Distinctive:

    Keep user-facing output concise and actionable.

    line 30
  13. Distinctive:

    When replacing a tool or changing its entrypoint, update callers, CI jobs, and docs in the same change.

    line 31
  14. Distinctive:

    Add or update focused tests when changing tool behavior.

    line 35

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

AGENTS.md - Tools Guide for AI Coding Agents

Scope: everything under tools/.

Tool choice

  • Prefer bash for small repo-local wrappers, CI entrypoints, and scripts that mostly orchestrate existing CLI tools.
  • Prefer Go for non-trivial tooling: structured parsing, manifest scanning, larger file transforms, concurrency, or logic that benefits from unit tests and a compiled binary.
  • Avoid adding new Python-based repo tooling when bash or Go is a reasonable fit. Some CI environments in this repo do not guarantee Python.
  • If Python is still required for a one-off command, use python3, not python.

Layout

  • Put general executable wrapper scripts in tools/scripts/.
  • Put CI-focused entrypoint scripts in tools/ci/.
  • Put larger Go tools in their own directory under tools/, for example tools/collect-dependencies/ or tools/generate-subproject-ci/.
  • If a Go tool needs a stable repo entrypoint for CI or docs, add a thin wrapper in tools/ci/ or tools/scripts/ as appropriate, or document the exact go run or go build -C command.

Naming

  • Use hyphens, not underscores, for filenames under tools/, especially under tools/scripts/.
  • Examples: collect-notices, check-license-headers, check-dependency-licenses, test-collect-notices.
  • Keep test entrypoints aligned with the tool name, for example test-<tool-name>.

Implementation

  • Keep tools easy to run in CI and local development. Prefer standard library code and common Unix tools over extra dependencies.
  • For bash scripts, prefer #!/usr/bin/env bash and set -euo pipefail unless there is a clear reason not to.
  • Keep user-facing output concise and actionable. Error messages should say what failed and how to fix it when possible.
  • When replacing a tool or changing its entrypoint, update callers, CI jobs, and docs in the same change.

Tests

  • Add or update focused tests when changing tool behavior.
  • For bash tools, prefer shell-based tests under tools/scripts/test/.
  • For Go tools, prefer _test.go unit tests next to the implementation.

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