obsidian-wechat-converter: Instructions file for Codex

AGENTS.md

obsidian-wechat-converter AGENTS.md is an instructions file for Codex, OpenCode from DavidLam-oss/obsidian-wechat-converter. It costs 8,119 tokens per session, scanned A, original, MIT.

Repository-specific instructions for an Obsidian plugin that converts Markdown notes into HTML articles for WeChat Official Accounts. They document the project's language preferences, commands, build process, and testing expectations.

In plain words
What is it for?
Use them when working on the plugin, especially when building it, generating embedded bundles, running tests, checking coverage, or preparing the development version.
Why use it?
Coding agents need project context and reliable commands to make changes safely. These instructions reduce guesswork about the codebase and how to check that changes still work.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: reads ~/.codex or $CODEX_HOME, but also the file is AGENTS.md. Also seen: mentions Claude Code; mentions AGENTS.md; mentions Codex.

This is DavidLam-oss/obsidian-wechat-converter's own configuration. It tells Codex and OpenCode how to work on obsidian-wechat-converter 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 obsidian-wechat-converter configures →

Reuse

Borrowing it

Nothing to install: this file belongs to DavidLam-oss/obsidian-wechat-converter. 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/DavidLam-oss/obsidian-wechat-converter/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/DavidLam-oss/obsidian-wechat-converter

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 obsidian-wechat-converter AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/davidlam-oss/obsidian-wechat-converter/agents-md/github.svg)](https://agentmods.dev/instructions/davidlam-oss/obsidian-wechat-converter/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/davidlam-oss/obsidian-wechat-converter/agents-md"><img src="https://agentmods.dev/badge/instructions/davidlam-oss/obsidian-wechat-converter/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 obsidian-wechat-converter AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/davidlam-oss/obsidian-wechat-converter/agents-md"><img src="https://agentmods.dev/badge/instructions/davidlam-oss/obsidian-wechat-converter/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 8,119 This file is loaded in full into every session.
When invoked 8,119 The same file — it is already loaded in full.
Security scan A 1 finding. 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.08119 $0.08119
Opus 5 $0.04059 $0.04059
Sonnet 5 $0.01624 $0.01624
Haiku 4.5 $0.00812 $0.00812

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

Security

Grade A, and why

obsidian-wechat-converter AGENTS.md scanned grade A with 1 finding 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 4d 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

- Avoid introducing new scan-triggering APIs: prefer DOM helpers over `innerHTML`, `setCssStyles(...)` over static `element.style.*`, Obsidian `Modal` over `confirm()`, and local parsing over `fetch(data:)`.
AGENTS.md · 194 lines

How it starts

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

AGENTS.md

This file provides guidance to Codex when working with code in this repository.

Language Preferences

  • Detect the language of the user's prompt (English or Chinese). Always reply in the same language unless explicitly asked otherwise.
  • When drafting replies or documentation intended for Chinese audiences, ensure natural, native-level phrasing.

Project Summary

  • This is an Obsidian plugin that converts Markdown notes into WeChat Official Account article HTML.
  • The core user workflow is: open the converter panel, preview the rendered article live, copy rich HTML into the WeChat editor, and optionally sync directly to the WeChat draft box.
  • The plugin is aimed at creators who publish from Obsidian to WeChat and care about fidelity for headings, code blocks, math, callouts, tables, local images, and article metadata.

Commands

  • Install dependencies: npm install
  • Generate embedded runtime bundles: npm run generate:embedded
  • Check embedded runtime bundles are up to date: npm run check:embedded
  • Build for production: npm run build
  • Start development watcher: npm run dev
  • Run unit tests: npm test
  • Run coverage: npm run test:coverage
  • Run fast Obsidian scan-risk guard: npm run scan:guard
  • Run Obsidian scan readiness guard: npm run review:guard
  • Check generated build artifacts: npm run check:build-artifacts
  • Release dry run: npm run release:dryrun
  • Release validation: npm run release:validate

Testing Expectations

  • This project still relies on manual visual testing for end-to-end rendering quality and WeChat paste/sync behavior.
  • Use TEST.md for general rendering checks.
  • Use TEST_MATH.md when touching formula rendering or math upload behavior.
  • Use OBSIDIAN_SCAN_CHECKLIST.md before merging feature branches or preparing a release candidate.
  • The repository also has a substantial Vitest suite under tests. For logic changes, especially around rendering, sanitization, path resolution, sync flow, or error handling, add or update unit tests unless the change is purely cosmetic.

Read the full file on GitHub · 194 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. 4d ago First seen · 194 lines · 8,119 tokens per session scan A fd434af8890d

Subscribe to this mod's changes

obsidian-wechat-converter AGENTS.md is an instructions file published in the GitHub repository DavidLam-oss/obsidian-wechat-converter (306 stars, last pushed 2d ago), licensed MIT. It adds 8,119 tokens to every session, about $0.0406 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-04.

Related

Other instructions, from other repositories

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,153 tokens

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

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

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

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