agentleFS
NVIDIAKnown publisherNVIDIA/elements/projects/starters/typescript/AGENTS.md

elements / typescript

AGENTS.md115 starsChanged 54 days agoApache-2.0View on GitHub

This file only covers how this starter wires Elements into a Vite TypeScript app. For component APIs, template validation, and project setup commands, use the Elements CLI/MCP documentation instead.

The file

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

10 rules. About 0 are common, 0 are distinctive, and 10 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    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:

    Keep global Elements CSS in src/index.css.

    line 8
  2. Very specific:

    Keep the module script pointing at ./index.ts from src/index.html.

    line 9
  3. Very specific:

    Keep root theme attributes on src/index.html.

    line 10
  4. Very specific:

    Import component classes as type imports when querying or narrowing DOM elements.

    line 14
  5. Very specific:

    Use querySelector<ComponentType>('nve-component') for local DOM access.

    line 15
  6. Very specific:

    Keep page-specific behavior in src/index.ts.

    line 17
  7. Very specific:

    Keep base: './' for archive-friendly static output.

    line 21
  8. Very specific:

    Keep source paths relative to the src root established by vite.config.ts.

    line 22
  9. Very specific:

    Run pnpm run build in projects/starters/typescript after HTML, TypeScript, CSS, or Vite changes.

    line 26
  10. Very specific:

    Run pnpm run lint after TypeScript edits.

    line 27

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

Elements TypeScript Starter

This file only covers how this starter wires Elements into a Vite TypeScript app. For component APIs, template validation, and project setup commands, use the Elements CLI/MCP documentation instead.

Integration Points

  • Register Elements in src/index.ts.
  • Keep global Elements CSS in src/index.css.
  • Keep the module script pointing at ./index.ts from src/index.html.
  • Keep root theme attributes on src/index.html.

TypeScript Usage

  • Import component classes as type imports when querying or narrowing DOM elements.
  • Use querySelector<ComponentType>('nve-component') for local DOM access.
  • Attach custom event listeners with addEventListener.
  • Keep page-specific behavior in src/index.ts; extract reusable behavior only after another page or component needs it.

Vite Constraints

  • Keep base: './' for archive-friendly static output.
  • Keep source paths relative to the src root established by vite.config.ts.

Verification

  • Run pnpm run build in projects/starters/typescript after HTML, TypeScript, CSS, or Vite changes.
  • Run pnpm run lint after TypeScript edits.

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.