agents AGENTS.md

Repository instructions for agents, a command-line tool for running specialized AI agents locally. The project includes a Go command-line program and a web page for reviewing conversation records.

In plain words
What is it for?
Use them when working on agent management, tool execution, file search, conversation logging, the Go command-line program, or the audit viewer.
Why use it?
They explain the project structure, technologies, and development expectations so coding agents can make changes in the correct component.

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/shonei/agents/agents-md
Clone the repo
git clone --depth 1 https://github.com/Shonei/agents

Made for: Codex, OpenCode.

Per session 1,002 This file is loaded in full into every session.
When invoked 1,002 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.01002 $0.01002
Opus 5 $0.00501 $0.00501
Sonnet 5 $0.00200 $0.00200
Haiku 4.5 $0.00100 $0.00100

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

Security

Grade A, and why

agents 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 · 84 lines

How it starts

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

AI Agent Instructions (AGENTS.md)

Welcome to the agents repository! This file provides context, architectural guidelines, and development workflows for AI coding assistants (like Cursor, Copilot, or Claude Code) working on this codebase.

Project Overview

agents is a command-line tool for managing and interacting with AI agents locally. It supports creating specialized agents with specific system prompts, models, and tools. It also features Retrieval-Augmented Generation (RAG) capabilities using local files and an Audit Logging system to track agent conversations.

The project consists of two main components:

  1. Go CLI: The core application, handling agent logic, tool execution, RAG indexing, and CLI interactions.
  2. Audit Viewer: A lightweight web application to visualize and review conversation logs stored in DuckDB.

Tech Stack

Backend (CLI)

  • Language: Go (1.25+)
  • CLI Framework: Cobra (github.com/spf13/cobra)
  • Database: DuckDB (github.com/duckdb/duckdb-go/v2) used for both RAG vector storage and Audit logging.
  • Markdown Rendering: Glamour (github.com/charmbracelet/glamour)

Frontend (Audit Viewer)

  • Runtime/Package Manager: Bun
  • Framework: React 18 with TypeScript
  • Database Driver: DuckDB (WASM/Node bindings)

Repository Structure

  • cmd/: Cobra CLI commands (e.g., add.go, engage.go, rag.go).
  • pkg/: Core application logic.
    • pkg/sdk/: The core agent SDK, handling interactions with the LLM (Gemini) and tool execution.
    • pkg/storage/: Database interactions (DuckDB) for RAG and Audit logs.
    • pkg/config/: Configuration parsing and management.
    • pkg/utils/: Helper functions.
  • audit-viewer/: The React/Bun web application for viewing audit logs.
  • examples/: Example configurations (e.g., PR reviewer agent).
  • docs/: Additional documentation.

Development Workflow

Go CLI

The project uses a Makefile for common tasks. Always ensure your code passes these checks before considering a task complete.

Read the full file on GitHub · 84 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. yesterday First seen · 84 lines · 1,002 tokens per session scan A 658d47d859d8

Subscribe to this mod's changes

agents AGENTS.md is an instructions file published in the GitHub repository Shonei/agents (2 stars, last pushed 27d ago), licensed MIT. It adds 1,002 tokens to every session, about $0.0050 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-31.

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

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

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

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

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