openagent: Instructions file for Claude Code

CLAUDE.md

openagent CLAUDE.md is an instructions file for Claude Code from the-open-agent/openagent. It costs 1,228 tokens per session, scanned A, original, Apache-2.0.

A repository guide for an open-source application with a Go backend and React frontend. It explains the project structure, development commands, tests, builds, and how the two parts work together.

In plain words
What is it for?
Use it when changing, testing, debugging, or building this Go and React application. It also helps explain how the backend serves the frontend and how production builds are created.
Why use it?
It gives a coding agent the project-specific instructions needed to work consistently in the repository. This reduces guesswork about commands, file locations, and how the application is built.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md; mentions Claude Code.

This is the-open-agent/openagent's own configuration. It tells Claude Code how to work on openagent 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 openagent configures →

About the project

OpenAgent is a self-hostable personal AI assistant that combines language models, document-based retrieval, and autonomous agent loops. It lets people connect model providers and their own knowledge bases, then have agents browse the web, run code, use computers, and call MCP-compatible tools.

the-open-agent/openagent · 5,730 stars · on GitHub · openagentai.org

Reuse

Borrowing it

Nothing to install: this file belongs to the-open-agent/openagent. 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/the-open-agent/openagent/master/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/the-open-agent/openagent

Made for: Claude Code.

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 openagent CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/the-open-agent/openagent/claude-md/github.svg)](https://agentmods.dev/instructions/the-open-agent/openagent/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/the-open-agent/openagent/claude-md"><img src="https://agentmods.dev/badge/instructions/the-open-agent/openagent/claude-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 openagent CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/the-open-agent/openagent/claude-md"><img src="https://agentmods.dev/badge/instructions/the-open-agent/openagent/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,228 This file is loaded in full into every session.
When invoked 1,228 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.01228 $0.01228
Opus 5.5 $0.00491 $0.00491
Sonnet 5.5 $0.00246 $0.00246
Haiku 4.5 $0.00123 $0.00123

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

Security

Grade A, and why

openagent CLAUDE.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 1mo 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.

CLAUDE.md · 74 lines

How it starts

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

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Commands

Backend (Go)

go build                    # build backend binary
go run main.go              # run backend (port 14000)
go test ./...               # run all tests
go test ./object/... -run TestFoo  # run a single test

Frontend (React + shadcn/ui, built with Vite)

cd web && yarn install
yarn start                  # dev server on port 13001, proxies /api to localhost:14000
yarn build                  # production build (vite writes build-temp, mv.js swaps it into web/build)
yarn typecheck              # tsc --noEmit
yarn lint                   # eslint

web-old/ holds the previous Ant Design frontend. It is kept for reference only while bugs are chased down against it — it is not built, served or linted, and it does not get new work.

Full production build uses build.sh which cross-compiles for linux/amd64, linux/arm64, linux/riscv64.

Backend serves the frontend as embedded static files (embed.go); during development the frontend proxy is configured to hit localhost:14000.

Architecture

Backend (Go / Beego)

Module: github.com/the-open-agent/openagent

The backend is a standard Beego MVC app. Every entity follows the same three-layer pattern:

  1. object/<entity>.go — struct definition (xorm tags for DB), and all DB access functions: GetGlobal<Entities>, Get<Entity>Count, GetPagination<Entities>, Get<Entity>, Add<Entity>, Update<Entity>, Delete<Entity>. The primary key is always (Owner string, Name string). Use util.GetId(owner, name) / util.GetOwnerAndNameFromIdWithError(id) for composite key serialization.

  2. controllers/<entity>.go — Beego controller methods wired to routes. Standard set: GetGlobal<Entities>, Get<Entities>, Get<Entity>, Add<Entity>, Update<Entity>, Delete<Entity>. Use c.IsAdmin() / c.IsGlobalAdmin() / c.RequireSignedIn() for auth. Paginated list APIs accept p, pageSize, field, value, sortField, sortOrder query params and use pagination.SetPaginator.

Read the full file on GitHub · 74 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. 1mo ago Changed · +8 lines · +179 tokens per session 23dbdde9a7cd
  2. 2mo ago First seen · 66 lines · 1,049 tokens per session scan A 7f03b4a36e27

Subscribe to this mod's changes

openagent CLAUDE.md is an instructions file published in the GitHub repository the-open-agent/openagent (5,730 stars, last pushed 4d ago), licensed Apache-2.0. It adds 1,228 tokens to every session, about $0.0049 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.

Related

openagent CLAUDE.md compared with instructions from other repositories

openagent CLAUDE.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
openagent CLAUDE.mdthe-open-agent/openagentInstructions file5.7k4d agoApache-2.0A1,228Claude Code
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149ktodayMITA4,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