ccx CLAUDE.md

A project instruction file for Claude Code that documents a codebase, its technology choices, directory structure, and common development commands.

In plain words
What is it for?
Use it to document how to develop, test, format, lint, build, and run the project, including separate frontend and Go backend work.
Why use it?
It gives the coding agent consistent project context so it can work with the repository’s conventions and run the right commands.

Instructions file

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/benedictking/ccx/claude-md
Clone the repo
git clone --depth 1 https://github.com/BenedictKing/ccx
Per session 1,665 This file is loaded in full into every session.
When invoked 1,665 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.01665 $0.01665
Opus 5 $0.00833 $0.00833
Sonnet 5 $0.00333 $0.00333
Haiku 4.5 $0.00167 $0.00167

Measured 3d ago against content hash 4a2760f3ecb6, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

ccx 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 3d 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 · 161 lines

How it starts

The opening of the file, as written. The whole thing — 161 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 this repository.

项目概述

CCX 是一个支持 Claude、OpenAI Chat、OpenAI Images、OpenAI Embeddings、Codex Responses 和 Gemini 的多上游 AI API 代理与协议转换网关,提供统一代理入口和 Web 管理界面。

技术栈: Go 1.25 + Gin(后端)+ Vue 3 + Vuetify 3 + TypeScript(前端)+ Docker
版本管理: 根目录 VERSION 是唯一版本源,构建时通过 backend-go/Makefile-ldflags 注入运行时版本信息。

常用命令

# 根目录(推荐)
make dev              # 同时启动前端开发服务器和后端热重载
make run              # 构建前端并运行 Go 后端
make frontend-dev     # 前端开发服务器
make build            # 构建前端并编译 Go 后端
make clean            # 清理构建文件

# Go 后端开发 (backend-go/)
make dev              # 热重载开发模式
make run              # 复制前端产物后直接运行
make build            # 构建生产版本
make test             # 运行所有测试
make test-cover       # 测试 + 覆盖率报告
make fmt              # 格式化代码
make lint             # 代码检查
make deps             # 更新依赖

# 前端开发 (frontend/)
bun install
bun run dev
bun run build
bun run type-check

架构概览

Client -> backend :3000 ->
  |- /                            -> Web UI
  |- /api/*                       -> Admin API
  |- /v1/messages                 -> Claude Messages proxy
  |- /v1/chat/completions         -> OpenAI Chat proxy
  |- /v1/responses                -> Codex Responses proxy
  |- /v1/images/{...}             -> OpenAI Images proxy
  |- /v1/embeddings               -> OpenAI Embeddings proxy
  |- /v1/models                   -> Models API
  `- /v1beta/models/*             -> Gemini proxy

六类正式渠道:

  • messages
  • chat
  • responses
  • gemini
  • images
  • vectors

核心设计模式

  1. Provider Pattern - backend-go/internal/providers/ 负责上游请求构造与响应处理。
  2. Converter Pattern - backend-go/internal/converters/ 负责 Responses 场景的协议转换。
  3. Session Manager - backend-go/internal/session/ 负责 Responses 多轮会话与 Trace 亲和性。
  4. Scheduler Pattern - backend-go/internal/scheduler/ 负责优先级、促销期、熔断与故障转移。

API 总览

代理入口

  • POST /v1/messages
  • POST /v1/messages/count_tokens
  • POST /v1/chat/completions
  • POST /v1/responses
  • POST /v1/responses/compact
  • GET /v1/models
  • GET /v1/models/:model
  • POST /v1beta/models/{model}:generateContent
  • POST /v1/images/generations
  • POST /v1/images/edits
  • POST /v1/images/variations
  • POST /v1/embeddings
  • GET /health

Read the full file on GitHub · 161 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. 3d ago First seen · 161 lines · 1,665 tokens per session scan A 4a2760f3ecb6

Subscribe to this mod's changes

ccx CLAUDE.md is an instructions file published in the GitHub repository BenedictKing/ccx (3,966 stars, last pushed 2d ago), licensed MIT. It adds 1,665 tokens to every session, about $0.0083 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

ClawRouter CLAUDE.md

Claude Code instructions for BlockRunAI/ClawRouter, covering clawrouter, commands, project structure, key dependencies and conventions.

BlockRunAI/ClawRouter · 535 tokens

SearChat CLAUDE.md

Claude Code instructions for yokingma/SearChat, covering claude.md, project overview, architecture, monorepo structure and key technologies.

yokingma/SearChat · 852 tokens

ima2-gen AGENTS.md

Instructions for lidge-jun/ima2-gen, covering ima2-gen — ai context, what this project does, tech stack, project structure and agent skills (packaged).

lidge-jun/ima2-gen · 1,235 tokens

InvestSkill copilot-instructions.md

Instructions for yennanliu/InvestSkill, covering investskill — github copilot setup & usage guide, installation & setup, automatic setup, verify setup and core stock analysis (6 frameworks).

yennanliu/InvestSkill · 3,183 tokens

InvestSkill GEMINI.md

Instructions for yennanliu/InvestSkill, covering investskill — gemini cli setup & usage guide, installation & setup, quick start, navigate to the investskill directory and start gemini cli (loads gemini.md automatically).

yennanliu/InvestSkill · 3,074 tokens

DevoxxGenieIDEAPlugin GEMINI.md

Instructions for devoxx/DevoxxGenieIDEAPlugin, a project described as: DevoxxGenie is an agentic plugin for IntelliJ IDEA that uses local LLM's (Ollama, LMStudio, GPT4All, Jan and Llama.cpp) and Cloud based LLMs to help review, test, explain your project code. Latest version now also supports Spec Driven Development…

devoxx/DevoxxGenieIDEAPlugin · 257 tokens