Guanlan: Instructions file for Codex

AGENTS.md

Guanlan AGENTS.md is an instructions file for Codex, OpenCode from shenyangs/Guanlan. It costs 9,305 tokens per session, scanned C, original, MIT.

A project instruction file for Guanlan, a command-line search tool designed for AI assistants. It defines where the project’s operating knowledge is kept and sets rules for research workflows, Chinese-language updates, version changes, and telemetry wording.

In plain words
What is it for?
Use it before building search workflows, updating documentation, preparing commits, or changing the project version across its listed files.
Why use it?
It keeps development and release work consistent with the project’s search focus, language expectations, and versioning requirements.

Instructions file for CodexOpenCode

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

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

Reuse

Borrowing it

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

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

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/shenyangs/guanlan/agents-md"><img src="https://agentmods.dev/badge/instructions/shenyangs/guanlan/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 9,305 This file is loaded in full into every session.
When invoked 9,305 The same file — it is already loaded in full.
Security scan C 2 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.09305 $0.09305
Opus 5.5 $0.03722 $0.03722
Sonnet 5.5 $0.01861 $0.01861
Haiku 4.5 $0.00931 $0.00931

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

Security

Grade C, and why

Guanlan AGENTS.md scanned grade C with 2 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 2d 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.

Downloads and executes remote codehighSupply chain

curl | sh runs whatever the server returns today, which is not necessarily what it returned when this was reviewed.

`curl -fsSL -H 'Cache-Control: no-cache' https://pypi.org/pypi/guanlan/json | python3 -c 'import json,sys; print(json.load(sys.stdin)["info"]["version"])'`

Makes network callslowCapability

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

`curl -fsSL -H 'Cache-Control: no-cache' https://pypi.org/pypi/guanlan/json | python3 -c 'import json,sys; print(json.load(sys.stdin)["info"]["version"])'`
AGENTS.md · 386 lines

How it starts

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

AGENTS.md

This repository is designed as a CLI-first search productivity tool for AI agents.

Memory rule: treat AGENTS.md, docs/agent-playbook.md, docs/agent-usage.md, and guanlan/skill/SKILL.md as the durable memory surfaces for how to operate Guanlan. Before building new benchmarks, automations, or MCP workflows, reread at least AGENTS.md and docs/agent-playbook.md.

Commit/release language rule: Guanlan is a Chinese-web research tool. Use Chinese-first commit subjects, changelog entries, and release notes. Keep conventional prefixes such as feat: / fix: / docs: when useful, but write the description in Chinese, for example feat: 扩展垂直路由和搜索质量反馈. In public-facing update text, commit subjects, release notes, and changelog summaries, do not proactively mention telemetry/遥测 unless the user explicitly asks for that topic or the change is specifically about its user-facing controls.

Version bump rule: every commit to Guanlan must increase the project version by 0.0.1. Before committing, bump the patch version across pyproject.toml, guanlan/__init__.py, uv.lock, README.md, docs/full-guide.md, docs/telemetry.md, website/index.html, and CHANGELOG.md; then run scripts/pre_release_status.sh or an equivalent version-sync check. Do not make a code/docs commit on main that leaves the package version unchanged.

Release sync rule: when shipping a new Guanlan version, keep the public distribution surfaces in lockstep. Do not call a release complete until the GitHub repo/tag, PyPI/uv install path, Homebrew tap formula (shenyangs/homebrew-tap), and official website (website/index.html plus any deployed site flow) all reflect the same version and positioning. If Homebrew reports an older stable version, run brew update first; if the tap itself is stale, update and push Formula/guanlan.rb before telling users Homebrew is current. If the website carries version, install, capability, or release copy, update and deploy it in the same release pass. Use scripts/publish_release.sh for real releases so pushing main and pushing the matching v* tag happen together; PyPI publishing is tag-triggered, so a version commit without a tag is not a complete release. Pushing main alone is never the end of a release. After the version commit lands, you must continue through scripts/publish_release.sh or an equivalent full release path until tag, PyPI, Homebrew tap, website deploy, and local installer verification all succeed for that same version.

Install/update rule: after installing or upgrading Guanlan, always do a full reinstall, not an incremental upgrade, before configuring MCP, optional channels, or auth. Prefer one clean path: uv tool install --force --upgrade --refresh --default-index https://pypi.org/simple guanlan; if the user explicitly wants Homebrew, run brew update && brew reinstall shenyangs/tap/guanlan; for pipx, run pipx install --force guanlan. For uv, --force alone is not enough because it can reinstall the previously locked version; include --upgrade and --refresh. Then refresh shell command lookup with hash -r when available, run command -v guanlan and which -a guanlan (or the platform equivalent), and run guanlan version. If the version does not match README/release notes, stop and report the path/version mismatch instead of configuring MCP or using the tool. If an Agent reports PyPI as older than GitHub, verify with direct PyPI JSON and pip's index source instead of search-result snippets or cached app text: curl -fsSL -H 'Cache-Control: no-cache' https://pypi.org/pypi/guanlan/json | python3 -c 'import json,sys; print(json.load(sys.stdin)["info"]["version"])' and python3 -m pip index versions guanlan --index-url https://pypi.org/simple. If Homebrew is stale, switch to the uv path.

Post-update smoke rule: after a full reinstall, run guanlan capabilities, guanlan doctor --install-check, guanlan doctor --trace, guanlan search "人工智能 政策" --profile china --limit 5 --trace, and guanlan read "https://example.com/" --backend direct --no-fallback-search --format json, and guanlan hotnews today --limit 5 --trends. Report the exact version, executable path, and smoke results to the user. Do not treat an old global executable as a successful update.

Read the full file on GitHub · 386 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. 2d ago Changed · +7 lines · +134 tokens per session f2766f177413
  2. 2mo ago First seen · 379 lines · 9,171 tokens per session scan C e79e835b1714

Subscribe to this mod's changes

Guanlan AGENTS.md is an instructions file published in the GitHub repository shenyangs/Guanlan (57 stars, last pushed 3d ago), licensed MIT. It adds 9,305 tokens to every session, about $0.0372 per session on Opus 5.5. A static security scan graded it C with 2 findings (downloads and executes remote code, makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Guanlan AGENTS.md compared with instructions from other repositories

Guanlan AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
Guanlan AGENTS.mdshenyangs/GuanlanInstructions file573d agoMITC9,305Codex, OpenCode
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
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode