markstream-vue: Instructions file for Codex

AGENTS.md

markstream-vue AGENTS.md is an instructions file for Codex, OpenCode from Simon-He95/markstream-vue. It costs 644 tokens per session, scanned A, original, MIT.

Repository instructions for a Vue 3 library, a JavaScript and TypeScript package for building user interfaces, including its source folders, demos, documentation, and tests.

In plain words
What is it for?
Developing components and shared utilities, building the library, generating TypeScript declarations, running Vitest tests, checking types, linting, and working on the VitePress documentation.
Why use it?
They tell an agent where code belongs and which commands to use for building, checking types, linting, testing, and running documentation or playgrounds.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

This is Simon-He95/markstream-vue's own configuration. It tells Codex and OpenCode how to work on markstream-vue itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything markstream-vue configures →

About the project

markstream-vue is a family of Markdown renderers that display AI-generated text while it is still arriving, including unfinished formatting, code blocks, diagrams, and mathematical notation. It is for AI chat interfaces built with Vue and other supported frameworks, with markstream-vue targeting Vue 3, Nuxt, and VitePress. The catalogue entries provide agent guidance for using the renderer family.

Simon-He95/markstream-vue · 3,051 stars · on GitHub · markstream.simonhe.me

Reuse

Borrowing it

Nothing to install: this file belongs to Simon-He95/markstream-vue. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/Simon-He95/markstream-vue/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/Simon-He95/markstream-vue

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for markstream-vue AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/simon-he95/markstream-vue/agents-md/github.svg)](https://agentmods.dev/instructions/simon-he95/markstream-vue/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/simon-he95/markstream-vue/agents-md"><img src="https://agentmods.dev/badge/instructions/simon-he95/markstream-vue/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for markstream-vue AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/simon-he95/markstream-vue/agents-md"><img src="https://agentmods.dev/badge/instructions/simon-he95/markstream-vue/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 644 This file is loaded in full into every session.
When invoked 644 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00644 $0.00644
Opus 5.5 $0.00258 $0.00258
Sonnet 5.5 $0.00129 $0.00129
Haiku 4.5 $0.00064 $0.00064

Measured 2mo ago against content hash 23d51d29f1fb, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

markstream-vue AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 43 lines

How it starts

The opening of the file, as written. The whole thing — 43 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Repository Guidelines

Project Structure & Module Organization

  • src/ is the Vue 3 library source.
    • src/components/*/ contains SFC components (PascalCase folders, *.vue files) and index.ts barrel exports.
    • src/utils/, src/types/, src/composables/ contain shared helpers, types, and composables.
    • Library entry points and styles are exported via src/exports.ts and src/index.css.
  • test/ contains Vitest specs (e.g. test/index.test.ts, test/plugins/*.test.ts).
  • playground/ and playground-nuxt/ are local demo apps for manual testing.
  • docs/ is the VitePress documentation site.
  • scripts/ contains maintenance utilities (DTS build, peer-deps checks, doc sync scripts).

Build, Test, and Development Commands

Use pnpm (see package.json#packageManager). Key commands:

  • pnpm dev / pnpm play: run the Vite playground.
  • pnpm build: build the library bundles and generate .d.ts.
  • pnpm test / pnpm test:ui: run tests (CLI/UI).
  • pnpm typecheck: run vue-tsc --noEmit.
  • pnpm lint / pnpm lint:fix: ESLint checks/fixes.
  • pnpm docs:dev / pnpm docs:build: run/build VitePress.

Coding Style & Naming Conventions

  • TypeScript-first, Vue 3 SFCs.
  • Indentation: 2 spaces, LF endings (see .editorconfig).
  • Components: PascalCase folder + file names (e.g. src/components/CodeBlockNode/CodeBlockNode.vue).
  • Helpers: camelCase functions; follow existing file naming in src/utils/.
  • Linting uses @antfu/eslint-config via eslint.config.mjs.

Testing Guidelines

  • Framework: Vitest (pnpm test).
  • Prefer small, focused unit tests for parsers/components; name files *.test.ts under test/.
  • Update snapshots with pnpm test:update.

Commit & Pull Request Guidelines

  • Commit messages follow Conventional Commits (e.g. feat:, fix:, docs:, chore:).
  • Link issues using GitHub keywords when applicable (e.g. close: #123).
  • PRs should include: clear description/rationale, linked issues, and screenshots/GIFs for UI-visible changes.
  • Before requesting review: run pnpm lint, pnpm typecheck, and pnpm test, then sanity-check the playground.

Read the full file on GitHub · 43 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2mo ago First seen · 43 lines · 644 tokens per session scan A 23d51d29f1fb

Subscribe to this mod's changes

markstream-vue AGENTS.md is an instructions file published in the GitHub repository Simon-He95/markstream-vue (3,051 stars, last pushed yesterday), licensed MIT. It adds 644 tokens to every session, about $0.0026 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

markstream-vue AGENTS.md compared with instructions from other repositories

markstream-vue AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
markstream-vue AGENTS.mdSimon-He95/markstream-vueInstructions file3.1kyesterdayMITA644Codex, OpenCode
create-trimble-app typescript.instructions.mdjulianoczkowski/create-trimble-appInstructions file34mo agoMITA583GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot