opencode.nvim AGENTS.md

Repository instructions for OpenCode.nvim covering how to build, test, format, configure, and inspect the project's dependency structure. They include commands for running all tests or a selected test.

In plain words
What is it for?
Use them when changing OpenCode.nvim, running tests, editing configuration or Lua code, or checking architectural dependencies with the provided scanner.
Why use it?
They give an agent a consistent way to verify changes and understand the project's architecture. The dependency-topology tool shows how the current code compares with the intended layering.

Instructions file for CodexOpenCode

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/sudo-tee/opencode.nvim/agents-md
Clone the repo
git clone --depth 1 https://github.com/sudo-tee/opencode.nvim

Made for: Codex, OpenCode.

Per session 271 This file is loaded in full into every session.
When invoked 271 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 $0.00271 $0.00271
Opus 5 $0.00135 $0.00135
Sonnet 5 $0.00054 $0.00054
Haiku 4.5 $0.00027 $0.00027

Measured yesterday against content hash 8cdb0af2775f, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

opencode.nvim 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 yesterday.

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 · 24 lines

What it actually says

AGENTS.md

Build, Lint, and Test

  • Run all tests: ./run_tests.sh
  • Run a single test: Replace the directory in the above command with the test file path, e.g.:
    • ./run_tests.sh -t tests/unit/test_example.lua

Code Style Guidelines

  • Comments: Avoid obvious comments that merely restate what the code does. Only add comments when necessary to explain why something is done, not what is being done. Prefer self-explanatory code.
  • Config: Centralize in config.lua. Use deep merge for user overrides.
  • Types: Use Lua annotations (---@class, ---@field, etc.) for public APIs/config.

Dependency Topology Tool

Use scripts/dependency-topology/scan_topology.py to inspect and track architectural layering.

  • Use python3 scripts/dependency-topology/scan_topology.py scan to inspect current-state vs target-policy gap
  • Use diff to inspect change direction (improved/regressed/neutral) between snapshots
  • Pass --snapshot <git-ref> for historical snapshots
  • Pass --json when feeding outputs into scripts or agents
  • Keep architecture cleanup discussions anchored on scanner output instead of ad-hoc grep chains
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. yesterday First seen · 24 lines · 271 tokens per session scan A 8cdb0af2775f

Subscribe to this mod's changes

opencode.nvim AGENTS.md is an instructions file published in the GitHub repository sudo-tee/opencode.nvim (932 stars, last pushed 10d ago), licensed Apache-2.0. It adds 271 tokens to every session, about $0.0014 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

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

buildNext

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

next.js 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

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

spec-kit 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,040 tokens

langchain 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,345 tokens