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

elements / vue

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

This file only covers how this starter wires Elements into Vue. 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

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

  • 11

    Very specific

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

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

    Keep template.compilerOptions.isCustomElement in vite.config.ts so Vue treats nve-* tags as custom elements.

    line 7
  2. Very specific:

    Keep custom-elements-vue.d.ts referenced from env.d.ts.

    line 8
  3. Very specific:

    Keep env.d.ts included by tsconfig.app.json.

    line 9
  4. Very specific:

    Keep global Elements CSS in src/main.css.

    line 11
  5. Very specific:

    Use :property for custom element properties.

    line 15
  6. Very specific:

    Use @event for custom Events.

    line 16
  7. Distinctive:

    Use plain attributes for static string values.

    line 17
  8. Very specific:

    Keep router links or app-specific components inside Elements slots normally.

    line 18
  9. Very specific:

    Use vue-tsc through the package build so invalid Elements attributes fail CI.

    line 22
  10. Very specific:

    If a new nve-* tag has no template type, verify the referenced generated type file includes it before adding local declarations.

    line 23
  11. Very specific:

    Run pnpm run build in projects/starters/vue after Vue, type, or config changes.

    line 27
  12. Very specific:

    Run pnpm run lint after source edits.

    line 28

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

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

Integration Points

  • Keep template.compilerOptions.isCustomElement in vite.config.ts so Vue treats nve-* tags as custom elements.
  • Keep custom-elements-vue.d.ts referenced from env.d.ts.
  • Keep env.d.ts included by tsconfig.app.json.
  • Register Elements in the SFC that renders them, as in src/App.vue.
  • Keep global Elements CSS in src/main.css.

Vue Syntax

  • Use :property for custom element properties.
  • Use @event for custom Events.
  • Use plain attributes for static string values.
  • Keep router links or app-specific components inside Elements slots normally.

Type Checking

  • Use vue-tsc through the package build so invalid Elements attributes fail CI.
  • If a new nve-* tag has no template type, verify the referenced generated type file includes it before adding local declarations.

Verification

  • Run pnpm run build in projects/starters/vue after Vue, type, or config changes.
  • Run pnpm run lint after source 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.