What is OpenGuider AGENTS.md?

A project instruction document for OpenGuider, an Electron and Node.js desktop application. It explains the project's structure, development commands, contribution rules, and safeguards for coding agents.

Use it to understand the codebase, install dependencies, run the app and tests, build releases, and follow contribution and security rules.

It gives contributors the local knowledge needed to make focused changes safely and avoid breaking project conventions or exposing secrets.

How mo-tunn/OpenGuider configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to mo-tunn/OpenGuider. 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/mo-tunn/OpenGuider/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/mo-tunn/OpenGuider

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/mo-tunn/openguider/agents-md/github.svg)](https://agentmods.dev/instructions/mo-tunn/openguider/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/mo-tunn/openguider/agents-md"><img src="https://agentmods.dev/badge/instructions/mo-tunn/openguider/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/mo-tunn/openguider/agents-md"><img src="https://agentmods.dev/badge/instructions/mo-tunn/openguider/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 573 This file is loaded in full into every session.

When invoked 573 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.

Model	Per session	Once invoked
Fable 5.1	$0.00573	$0.00573
Opus 5.5	$0.00229	$0.00229
Sonnet 5.5	$0.00115	$0.00115
Haiku 4.5	$0.00057	$0.00057

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

Security

Grade A, and why

OpenGuider 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 · 67 lines

How it starts

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

AGENTS.md

This file helps both human contributors and agentic coding AIs work safely and consistently in OpenGuider.

Project Snapshot

Stack: Electron + Node.js (CommonJS), vanilla HTML/CSS/JS renderer.
Entry points: main.js (main process), preload.js (IPC bridge), renderer/ (UI).
Core domains:
- src/ai/ provider integrations and streaming logic
- src/agent/ planning, orchestration, structured tool flows
- src/session/ session state and persistence
- src/tts/ text-to-speech providers
- src/store.js + src/secure-store.js app settings and secret handling

Local Development

Install deps: npm install
Run app: npm run start
Run tests: npm test
Build artifacts:
- npm run dist:win
- npm run dist:mac
- npm run dist:linux

Contribution Rules

Keep changes focused; avoid unrelated refactors in the same PR.
Preserve backward compatibility for existing settings keys whenever possible.
Do not commit secrets, tokens, personal data, or local machine artifacts.
If touching provider logic, keep fallback defaults explicit and robust.
Update docs/UI text when behavior changes (especially settings and provider fields).

AI Agent Guardrails

Read nearby code before editing; follow existing naming and style conventions.
Prefer minimal, surgical changes over broad rewrites.
Do not remove existing user-facing features unless explicitly requested.
Do not run destructive git commands (reset --hard, force push, history rewrite).
Respect current branch/worktree state; do not revert unrelated local changes.
Validate impacted flows with tests or targeted manual verification steps.

Testing Expectations

At minimum, run npm test after meaningful code changes.
When modifying provider behavior, ensure AI provider tests still pass.
If tests fail due to environment/dependency setup rather than your change, state that clearly in PR notes.

PR Checklist

Clear title and short "why" summary.
List user-visible changes (settings, provider behavior, UI, shortcuts, permissions).
Mention validation performed (npm test, manual checks).
Call out any limitations, follow-ups, or non-blocking risks.

Read the full file on GitHub · 67 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.

2mo ago First seen · 67 lines · 573 tokens per session scan A fe441c7b7ff3

Subscribe to this mod's changes

OpenGuider AGENTS.md is an instructions file published in the GitHub repository mo-tunn/OpenGuider (174 stars, last pushed 16d ago), licensed Apache-2.0. It adds 573 tokens to every session, about $0.0023 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.

Writing and docs ai-agents ai-api ai-tools electron-app javascript multi-platform

OpenGuider AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
OpenGuider AGENTS.mdmo-tunn/OpenGuider	Instructions file	174	16d ago	Apache-2.0	A	573	Codex, OpenCode
vibetags com-example-config-AsyncTestConfig.instructions.mdPIsberg/vibetags	Instructions file	25	today	MIT	A	82	GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	today	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	3,093	GitHub Copilot

OpenGuider: Instructions file for Codex