What is openlens CLAUDE.md?

A set of development instructions for OpenLens, including its build commands, debugging options, Git hooks, and architecture. Git hooks are automatic checks that run during actions such as committing or pushing code.

Use it to install dependencies, run or type-check the project, run tests, enable debug logs, and manage pre-commit and pre-push hooks.

It gives contributors a consistent way to build, test, debug, and enforce checks before changes are shared.

How Traves-Theberge/openlens configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to Traves-Theberge/openlens. 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/Traves-Theberge/openlens/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/Traves-Theberge/openlens

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/traves-theberge/openlens/claude-md/github.svg)](https://agentmods.dev/instructions/traves-theberge/openlens/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/traves-theberge/openlens/claude-md"><img src="https://agentmods.dev/badge/instructions/traves-theberge/openlens/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/traves-theberge/openlens/claude-md"><img src="https://agentmods.dev/badge/instructions/traves-theberge/openlens/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,395 This file is loaded in full into every session.

When invoked 1,395 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.

Model	Per session	Once invoked
Fable 5.1	$0.01395	$0.01395
Opus 5	$0.00698	$0.00698
Sonnet 5	$0.00279	$0.00279
Haiku 4.5	$0.00139	$0.00139

Measured 9d ago against content hash c6fbcbdbd908, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, from the pricing page.

Security

Grade A, and why

openlens 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 9d 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 · 102 lines

How it starts

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

Build & Development Commands

bun install              # Install dependencies
bun run dev              # Run from source (alias for: bun run src/index.ts)
bun run build            # Compile TypeScript to dist/
bun run typecheck        # Type-check without emitting (tsc --noEmit)
bun test                 # Run all tests (Bun test runner)
bun test test/unit/config.test.ts  # Run a single test file

No linter is configured; TypeScript strict mode is the primary code quality gate.

Debugging

Set OPENLENS_DEBUG=1 to enable verbose debug logging to stderr. This prints timestamped SSE connection details, session polling status, and agent execution traces — useful for troubleshooting review timeouts and OpenCode server connectivity issues.

Git Hooks

openlens hooks install           # Install pre-commit + pre-push hooks
openlens hooks remove            # Remove hooks, restore backups
OPENLENS_SKIP=1 git commit -m x # Skip hooks for one operation

hooks/pre-commit — runs security+bugs agents on staged changes (~15s), blocks on critical
hooks/pre-push — runs all agents on full branch diff (~60s), blocks on critical
Idempotent install; backs up existing hooks; remove restores them

Architecture

openlens is an AI-powered code review tool with four interfaces: CLI (yargs), library (programmatic API), HTTP server (Hono), and OpenCode plugin.

Core Flow

Config loading (src/config/config.ts) — Layered resolution: built-in defaults → ~/.config/openlens/openlens.json → ./openlens.json → OPENLENS_* env vars → CLI flags. Validated with Zod schemas in src/config/schema.ts.
Agent loading (src/agent/agent.ts) — Resolves prompt from inline string, {file:path} reference, or built-in markdown in agents/. Parses YAML frontmatter, merges permissions (defaults → global config → frontmatter → agent config).
Diff collection (src/tool/diff.ts) — Gets staged, unstaged, or branch diff via git commands.
Review orchestration (src/session/review.ts) — Runs agents in parallel (up to maxConcurrency, default 4) via the OpenCode SDK. Each agent receives project instructions + diff + optional full file context. Results are parsed as JSON, suppressed issues filtered, then an optional verification pass re-examines flagged issues.
Output formatting (src/output/format.ts) — Text (ANSI), JSON, SARIF v2.1.0, or GitHub-flavored Markdown.

Read the full file on GitHub · 102 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.

9d ago First seen · 102 lines · 1,395 tokens per session scan A c6fbcbdbd908

Subscribe to this mod's changes

openlens CLAUDE.md is an instructions file published in the GitHub repository Traves-Theberge/openlens (6 stars, last pushed 5mo ago), licensed MIT. It adds 1,395 tokens to every session, about $0.0070 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.

actions agents cicd claude cli codex

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

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,153 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

openlens: Instructions file for Claude Code