opencode.nvim: Instructions file for Codex

AGENTS.md

opencode.nvim AGENTS.md is an instructions file for Codex, OpenCode from silvabyte/opencode.nvim. It costs 386 tokens per session, scanned A, original, MIT.

A repository-specific instruction file for working on the opencode.nvim project, a Neovim plugin. It documents formatting, linting, Lua coding style, error handling, asynchronous code, and issue commands.

In plain words
What is it for?
Use it when editing this repository, especially when formatting Lua, running checks, handling errors, writing asynchronous code, or managing Beads issues.
Why use it?
It gives a coding agent the project's expected rules and commands, reducing inconsistent changes and avoidable build or review failures.

Instructions file for CodexOpenCode

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

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

Reuse

Borrowing it

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

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 opencode.nvim AGENTS.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/silvabyte/opencode.nvim/agents-md"><img src="https://agentmods.dev/badge/instructions/silvabyte/opencode.nvim/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 386 This file is loaded in full into every session.
When invoked 386 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.00386 $0.00386
Opus 5.5 $0.00154 $0.00154
Sonnet 5.5 $0.00077 $0.00077
Haiku 4.5 $0.00039 $0.00039

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

What it actually says

AGENTS.md

Build/Lint Commands

  • make fmt - Format code with stylua
  • make lint - Lint code with selene
  • make check - Run both fmt and lint
  • No test framework configured

Code Style

  • Formatter: stylua (2-space indent, 100 col width, double quotes, always use parens)
  • Linter: selene with lua51+vim standard
  • Module pattern: local M = {} ... return M
  • Naming: snake_case for functions/variables, _prefix for private, SCREAMING_CASE for constants
  • Types: Use LuaDoc annotations (---@class, ---@param, ---@return, ---@field)
  • Imports: Top of file, local foo = require("opencode.foo")

Error Handling

  • Use pcall for safe requires and risky operations
  • Guard clauses with early returns for invalid state
  • vim.notify(msg, vim.log.levels.ERROR) for user-facing errors

Async Patterns

  • vim.defer_fn(fn, ms) for delays, vim.schedule(fn) for next tick
  • Callback-based async (no coroutines), e.g. fn(ctx, function(ok, result) end)

Issue Tracking (Beads)

This repo uses Beads for AI-native issue tracking. Issues live in .beads/issues.jsonl.

Common commands:

  • bd list - View all issues
  • bd show <id> - View issue details
  • bd create "title" - Create new issue
  • bd update <id> --status in-progress|done - Update status
  • bd sync - Sync with git remote
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. 20d ago First seen · 35 lines · 386 tokens per session scan A e323f1166546

Subscribe to this mod's changes

opencode.nvim AGENTS.md is an instructions file published in the GitHub repository silvabyte/opencode.nvim (10 stars, last pushed 11mo ago), licensed MIT. It adds 386 tokens to every session, about $0.0015 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-10-09.

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,461 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,750 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens