auroraview: Instructions file for Codex

AGENTS.md

auroraview AGENTS.md is an instructions file for Codex, OpenCode from loonghao/auroraview. It costs 1,325 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; mentions CLAUDE.md; mentions AGENTS.md.

This is loonghao/auroraview's own configuration. It tells Codex and OpenCode how to work on auroraview 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 auroraview configures →

Reuse

Borrowing it

Nothing to install: this file belongs to loonghao/auroraview. 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/loonghao/auroraview/main/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/github.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/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 auroraview AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/loonghao/auroraview/agents-md"><img src="https://agentmods.dev/badge/instructions/loonghao/auroraview/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,325 This file is loaded in full into every session.
When invoked 1,325 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.01325 $0.01325
Opus 5.5 $0.00530 $0.00530
Sonnet 5.5 $0.00265 $0.00265
Haiku 4.5 $0.00133 $0.00133

Measured 26d ago against content hash 58966d022c3f, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 26d 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 · 98 lines

How it starts

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

AGENTS.md — AuroraView

Lightweight WebView framework for DCC hosts (Maya, Houdini, Blender, 3ds Max…): Rust core + PyO3 bindings, WebView2 embedded into a Qt host on Windows. Navigation map for AI agents, not a reference manual. Follow the links; do not read everything up front.

Build & test

vx just dev      # install deps (vx uv sync --group dev) + build extension module
vx just build    # build the extension module (maturin develop)
vx just test     # Rust crate tests + Python unit/integration tests
vx just check    # format + lint + test (run before opening a PR)
vx just lint     # unsafe-audit + clippy + ruff
vx just format   # cargo fmt + ruff format

Every tool command goes through vx; task orchestration goes through vx just <recipe>. Do not call cargo / pytest / maturin directly — the just recipes carry the platform- and feature-specific flags. Full recipe list: vx just --list.

Repo layout

Path Role
crates/ Rust crates (auroraview-core protocol + WebView backend abstraction, auroraview-cli, auroraview-pack, …)
python/auroraview/ Python package — AuroraView base class and DCC host layer
packages/auroraview-sdk/ TypeScript/JS front-end SDK
gallery/ Gallery demo app, used as the E2E baseline
examples/ Runnable examples
tests/ Python unit + integration tests; Rust integration tests live in crates/<name>/tests/
docs/ VitePress site for humans (DCC integration, API, RFCs); docs/zh/ is the Chinese mirror
llms.txt AI-friendly core usage index (5-minute read)
llms-full.txt Complete usage index — every API signature and module note
.codebuddy/rules/ Topic-split execution rules — the real constraints behind CI and local dev

Task → where to look

Your task Go here
Understand the architecture and conventions llms.txt
Write / change / review code .codebuddy/rules/ (8 topic files)
Look up full API and architecture detail llms-full.txt
Human-readable deep docs docs/
Packaging, release, CI .codebuddy/rules/08-architecture.mdc
Front-end JS ↔ Python bridge .codebuddy/rules/05-frontend-api.mdc + 07-event-system.mdc
Python layer API .codebuddy/rules/06-python-api.mdc
Test strategy .codebuddy/rules/03-testing.mdc

Read the full file on GitHub · 98 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. 26d ago Changed · +25 lines · +235 tokens per session 58966d022c3f
  2. 1mo 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 (47 stars, last pushed 24d ago), licensed MIT. It adds 1,325 tokens to every session, about $0.0053 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

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 · 9,715 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,581 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens