auroraview AGENTS.md

auroraview AGENTS.md is an instructions file for Codex, OpenCode from loonghao/auroraview. It costs 1,090 tokens per session, scanned A, original, MIT.

An AI-friendly navigation guide for AuroraView, a lightweight web-page framework for desktop creative tools such as Maya, Houdini, and Blender. It uses Rust, Python bindings, and embedded WebView2 pages inside a Qt application.

In plain words
What is it for?
Quickly locating project guidance, changing Rust or Python code, working with the TypeScript SDK, handling events and APIs, running tests, and building the project.
Why use it?
It points agents to the right documentation and rules for coding, APIs, testing, building, packaging, and communication between JavaScript and Python.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: reads .claude/ paths.

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/loonghao/auroraview/agents-md
Clone the repo
git clone --depth 1 https://github.com/loonghao/auroraview

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 auroraview AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/loonghao/auroraview/agents-md.svg)](https://agentmods.dev/instructions/loonghao/auroraview/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/loonghao/auroraview/agents-md"><img src="https://agentmods.dev/badge/instructions/loonghao/auroraview/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,090 This file is loaded in full into every session.
When invoked 1,090 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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.01090 $0.01090
Opus 5 $0.00545 $0.00545
Sonnet 5 $0.00218 $0.00218
Haiku 4.5 $0.00109 $0.00109

Measured 6d ago against content hash e3ba781f062e, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-05, from the pricing page.

Security

Grade A, and why

auroraview 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 6d 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 · 73 lines

How it starts

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

AuroraView — AI Agent 导航图

渐进式披露入口。先读此图,再按任务类型跳转到对应深度文档。

项目一句话

AuroraView 是一个面向 DCC(Maya/Houdini/Blender 等)的轻量 WebView 框架,Rust 核心 + PyO3 Python 绑定,Windows 优先使用 WebView2 嵌入 Qt 宿主。


按任务快速导航

你的任务 先去这里 说明
了解整体架构与约定 llms.txt AI 友好的核心用法索引(5 分钟速读)
写代码 / 改逻辑 / Review .codebuddy/rules/ 8 个按主题划分的执行约定,是 CI 与本地开发的真实约束
查完整 API 与架构细节 llms-full.txt 完整用法索引,包含所有 API 签名与模块说明
给人看的详细文档 docs/ VitePress 站点,含 DCC 集成指南、API 文档、RFC
了解打包/发布/CI .codebuddy/rules/08-architecture.mdc 项目结构、auroraview-pack 打包系统、CI 流程
前端 JS ↔ Python 通信 .codebuddy/rules/05-frontend-api.mdc + .codebuddy/rules/07-event-system.mdc window.auroraview 协议与事件分发
Python 层接口 .codebuddy/rules/06-python-api.mdc AuroraView 基类、bind_callemit
测试策略 .codebuddy/rules/03-testing.mdc rstest / pytest、CI 矩阵、性能基线

30 秒项目速览

  • 命令入口:所有工具命令通过 vx 执行,任务编排通过 vx just <task>
  • 兼容底线:Python 3.7+,不引入第三方 Python 依赖(仅一个 .pyd)。
  • 测试入口vx just test(统一本地与 CI)。
  • 构建入口vx just build
  • 技术栈:Rust(windows-rs / webview2-com / PyO3)+ Python ABI3 wheel + TypeScript SDK。
  • 事件循环:Qt 宿主负责事件循环,Rust 不接管消息泵。

目录结构地图

├── crates/                 Rust crates
│   ├── auroraview-core/    核心协议与 WebView 后端抽象
│   ├── auroraview-cli/     CLI 工具与 Skills 分发
│   └── ...
├── python/auroraview/      Python 包(AuroraView 基类、DCC 宿主层)
├── packages/               TS/JS 包(前端 SDK)
│   └── auroraview-sdk/
├── gallery/                Gallery 演示应用(E2E 验证基准)
├── examples/               示例代码
├── docs/                   面向开发者的详细文档(VitePress)
├── submodules/             Git submodules(pack / protect / signals / extensions)
└── .codebuddy/rules/       AI 代理执行约定(真相之源)

关键约定速查(不可违背)

  1. 禁止裸命令:永远 vx just build,不要直接 cargo buildpytest
  2. 禁止代码内 emoji:保持专业风格。
  3. 函数命名:简短精炼,使用行业标准术语,避免 optimizedfixed 等词。
  4. 测试位置:Rust 集成测试放在各 crate 的 tests/ 目录,使用 rstest;不要内联单元测试。
  5. Skills 真相源:官方 Skills 在 crates/auroraview-cli/skills/<name>/SKILL.md.cursor/skills/.claude/skills/ 只是本地镜像,禁止复制。
  6. JS 事件统一:Rust 层事件分发统一使用 window.auroraview.trigger(),不混用原生 CustomEvent

Read the full file on GitHub · 73 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. 6d ago First seen · 73 lines · 1,090 tokens per session scan A e3ba781f062e

Subscribe to this mod's changes

auroraview AGENTS.md is an instructions file published in the GitHub repository loonghao/auroraview (44 stars, last pushed 1mo ago), licensed MIT. It adds 1,090 tokens to every session, about $0.0054 per session on Opus 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

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens