openlens: Instructions file for Claude Code

CLAUDE.md

openlens CLAUDE.md is an instructions file for Claude Code from Traves-Theberge/openlens. It costs 1,847 tokens per session, scanned A, original, MIT.

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.

In plain words
What is it for?
Use it to install dependencies, run or type-check the project, run tests, enable debug logs, and manage pre-commit and pre-push hooks.
Why use it?
It gives contributors a consistent way to build, test, debug, and enforce checks before changes are shared.

Instructions file for Claude Code

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

This is Traves-Theberge/openlens's own configuration. It tells Claude Code how to work on openlens 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 openlens configures →

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.

agentmods badge for openlens CLAUDE.md

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.

agentmods 80×15 button for openlens CLAUDE.md

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,847 This file is loaded in full into every session.
When invoked 1,847 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.01847 $0.01847
Opus 5.5 $0.00739 $0.00739
Sonnet 5.5 $0.00369 $0.00369
Haiku 4.5 $0.00185 $0.00185

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

How it starts

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

Repository Guidelines & AI Assistant Instructions

This file provides guidance for AI coding assistants (Claude Code, OpenCode / AI agents, and Gemini CLI) when working with code in this repository.

Note: CLAUDE.md, AGENTS.md, and GEMINI.md are maintained at strict parity. Any update to one must be mirrored across all three.

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

Repository Rules & Standards

1. Mandatory Documentation Updates & Parity

Whenever you make notable changes, add features, fix bugs, modify architecture, or update packages/dependencies, you MUST update documentation in the same change:

  • CHANGELOG.md: Add an entry under the appropriate version section following Keep a Changelog standards (Added, Changed, Fixed, Deprecated, Removed, Security).
  • README.md: Keep installation, usage instructions, feature lists, supported platforms, and configuration examples accurate and up to date.
  • docs/ & wiki/: Update relevant how-to guides and architecture docs when behaviors, flags, or interfaces change.
  • CLAUDE.md, AGENTS.md, and GEMINI.md: MUST be kept at complete parity at all times. Any rule, command, architecture update, or workflow guidance added to one must be mirrored across all three.

Read the full file on GitHub · 122 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. 4d ago Changed · +20 lines · +452 tokens per session bae1d7ed9001
  2. 1mo 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 4d ago), licensed MIT. It adds 1,847 tokens to every session, about $0.0074 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-31.

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

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens