agentmods.dev

polar: Instructions file for Claude Code

CLAUDE.md

polar CLAUDE.md is an instructions file for Claude Code from jamaljsr/polar. It costs 2,581 tokens per session, scanned A, original, MIT.

A repository guide for Polar, a desktop app that runs local Bitcoin and Lightning Network simulations in Docker containers. It lists the commands used to develop, test, lint, build, and package the app.

In plain words
What is it for?
Use it when changing Polar, running one test file, checking code quality, running the full test suite, or creating a packaged desktop build.
Why use it?
It gives a coding agent the project background and the exact commands needed to work safely in the repository. This avoids guessing how to run tests or build the desktop app.

Instructions file for Claude Code

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

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

Needs its repository: it reads a path above its own folder, which exists only inside the repository. The line is import { dockerService } from '../lib/docker';.

not rated 858repo +1 3d ago A scan 2,581 tokens original MIT
View source ↗ jamaljsr/polar lightningpolar.com
Reuse

Borrowing it

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

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

README.md
[![agentmods](https://agentmods.dev/badge/instructions/jamaljsr/polar/claude-md.svg)](https://agentmods.dev/instructions/jamaljsr/polar/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/jamaljsr/polar/claude-md"><img src="https://agentmods.dev/badge/instructions/jamaljsr/polar/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 2,581 This file is loaded in full into every session.
When invoked 2,581 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.02581 $0.02581
Opus 5 $0.01290 $0.01290
Sonnet 5 $0.00516 $0.00516
Haiku 4.5 $0.00258 $0.00258

Measured 7d ago against content hash 8478a46291cd, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

polar 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 7d 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 · 326 lines

How it starts

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

About Polar

Polar is a desktop application for creating local Bitcoin Lightning Network simulations for development and testing. It orchestrates Bitcoin (bitcoind) and Lightning nodes (LND, Core Lightning, Eclair) using Docker containers, providing a visual interface for network management, channel operations, and payment testing.

Essential Commands

Development

yarn                # Install dependencies
yarn dev            # Run with hot-reload (React + Electron restart)
yarn test           # Run unit tests in watch mode
yarn test:ci        # Run unit tests with coverage
yarn test:e2e       # Run end-to-end tests (builds first)
yarn lint:all       # Run TypeScript + ESLint checks
yarn ci             # Full CI check (lint + test:ci)

Testing Individual Files

# Run a single test file
yarn test path/to/file.spec.ts

# Run tests matching a pattern
yarn test --testPathPattern=network

# Run specific test by name
yarn test -t "test name"

Building

yarn build          # Build React app
yarn package        # Build + package desktop app for current OS

Architecture Overview

Dual-Process Electron Architecture

Main Process (/electron):

  • Entry point: electron/index.ts (compiles to public/main/electron/index.js)
  • Window lifecycle and IPC orchestration via windowManager.ts
  • gRPC proxy servers for Lightning nodes (LND, CLN, Eclair) and Taproot Assets
  • HTTP bridge for MCP server integration (mcpBridge.ts on port 37373)

Renderer Process (/src):

  • Entry point: src/index.tsx
  • React app with Redux state management via Easy-Peasy
  • Cannot directly access filesystem or make gRPC calls (uses IPC to main process)

Why Proxy Pattern for Node Communication?

The renderer process cannot access Docker volumes or make gRPC calls. The main process:

  1. Reads TLS certs and macaroons from Docker volumes
  2. Creates and caches gRPC clients
  3. Proxies requests from renderer via IPC
  4. Streams real-time events (channels, invoices) back to UI

Read the full file on GitHub · 326 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. 7d ago First seen · 326 lines · 2,581 tokens per session scan A 8478a46291cd

Subscribe to this mod's changes

polar CLAUDE.md is an instructions file published in the GitHub repository jamaljsr/polar (858 stars, last pushed 3d ago), licensed MIT. It adds 2,581 tokens to every session, about $0.0129 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.

Reactbitcoindockerelectronlightning-networkpolar
Related

Other instructions, from other repositories

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

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

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