Skip to main content
VelinStyle v0.9.0
⌂ Home
  1. Docs
  2. Guides
  3. Velin-Meta

Velin-Meta (AI agents) 0.9.0

Machine-readable context for Cursor, Copilot, and custom agents — structured JSON, not hidden from humans.

1. What Velin-Meta is (and is not)

Velin-Meta is agent-optimized metadata: a compact snapshot of VelinStyle conventions, components, CLI, and doc links. It is not encryption, DRM, or “KI-only” access — any HTTP client can fetch velin-agent.json.

2. MIME and files

ArtifactRole
dist/velin-agent.jsonCanonical bundle (components, CLI, conventions)
dist/llms.txtShort index (llms.txt convention)
application/vnd.velinstyle.meta+jsonMIME for page-level <script id="velin-meta">

Published on this site at /dist/velin-agent.json and /dist/llms.txt.

3. Live preview (this site)

Fetch the published bundle and inspect page-level meta embedded in this HTML — same artifacts agents use.

Global bundle summary

Open JSON llms.txt Feature scope

Loading…

Page meta on this page

From <script id="velin-meta">


          

npx velinstyle meta page my.html --write

4. Global bundle (velinstyle meta)

npx velinstyle meta
npx velinstyle meta --base-url https://velinstyle.info
npm run meta:build

CI runs meta:build and fails if committed dist/velin-agent.json or dist/llms.txt drift from source.

Programmatic: import { buildAgentBundle } from '@birdapi/velinstyle/meta'.

Component inventory (0.9.0)

The bundle’s components object is derived from component-loaders.js (audit-harmonized):

Also includes attributes (27 built-in), cli, a11y, searchIndex, and documentation roots.

5. Page-level meta

<script type="application/vnd.velinstyle.meta+json" id="velin-meta">
{
  "page": { "intent": "component-doc", "source": "docs/components/buttons.html" },
  "allowed": { "classesPrefix": ["velin-"], "components": ["velin-modal"] }
}
</script>
npx velinstyle meta page my-page.html --write

Do not put secrets, API keys, or raw PII in page meta.

6. CLI workflows

7. Cursor and other agents

Add to project rules or @-mention the bundle URL:

When editing VelinStyle HTML:
- Use only velin-* classes and documented velin-* Web Components.
- Follow dist/velin-agent.json conventions.
- Run velinstyle scan on new markup.
- Resolve doc links from /docs/ root, not the current folder.

Related: Prompt scaffolding, API reference (generated).

8. Security