nui: Instructions file for Claude Code

CLAUDE.md

nui CLAUDE.md is an instructions file for Claude Code from plmbr/nui. It costs 3,068 tokens per session, scanned A, original, MIT.

Repository instructions for NUI, a Go backend with a Vite-based web interface that can run coding agents and package the interface into the server binary.

In plain words
What is it for?
Running development servers, building and testing the Go backend and web interface, checking code quality, and creating Docker images.
Why use it?
They show the required build order and test commands, including the need to build the frontend before compiling the Go server.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: reads .claude/ paths; mentions CLAUDE.md; mentions Claude Code.

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

Reuse

Borrowing it

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

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

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/plmbr/nui/claude-md"><img src="https://agentmods.dev/badge/instructions/plmbr/nui/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 3,068 This file is loaded in full into every session.
When invoked 3,068 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.03068 $0.03068
Opus 5.5 $0.01227 $0.01227
Sonnet 5.5 $0.00614 $0.00614
Haiku 4.5 $0.00307 $0.00307

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

Security

Grade A, and why

nui 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 · 206 lines

How it starts

The opening of the file, as written. The whole thing — 206 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 ./...          # compile
go test . ./cmd/... ./internal/...  # run tests (avoids ui/node_modules)
./scripts/test-all.sh               # Go + Vitest + Playwright E2E
go run . server             # build + run server on :8080
go run . server --port 3000 # custom port (use this for development)
go run . server -a claude-code -m "Review README" -w . --open --hide-input

Frontend (run from ui/)

npm install
npm run dev     # Vite dev server with HMR (proxies /api to Go server)
npm run build   # compile to ui/dist (required before go build)
npm run lint    # ESLint

Full production build

cd ui && npm run build && cd .. && go build -o nui_bin . && ./nui_bin server

ui/dist must exist before go build — it is embedded into the binary at compile time via ui/embed.go (//go:embed all:dist).

Docker images (run from docker/)

docker build -f claude-code/Dockerfile -t nui-claude-code:latest .
docker build -f pi/Dockerfile          -t nui-pi:latest           .
docker build -f codex/Dockerfile       -t nui-codex:latest        .
docker build -f opencode/Dockerfile    -t nui-opencode:latest     .

All docker sandbox images listen on port 8090 and share http_nui_agent.py. They forward ANTHROPIC_API_KEY, ANTHROPIC_BASE_URL, OPENAI_API_KEY, and OPENAI_BASE_URL from the host. nui adds --add-host=<hostname>:host-gateway when a base URL resolves to loopback.

Architecture

Request flow

flowchart LR
  Browser -->|REST| API["/api/*"]
  Browser -->|AG-UI SSE| AGUI["/api/sessions/:id/ag-ui"]
  API --> Store["~/.nui/data.json"]
  AGUI --> ADLAgent
  ADLAgent --> Manager
  Manager --> Harnesses["ClaudeCode / Pi / Codex / OpenCode"]
  Manager --> HTTPExt["HTTPExtensionAgent"]
  HTTPExt --> DockerRemote["Docker / Remote"]

In development, Vite (:5173) proxies /api to the Go server.

Read the full file on GitHub · 206 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 · +5 tokens per session 850f4827e87c
  2. 1mo ago Changed · +3 lines · +147 tokens per session e577869eee28
  3. 1mo ago Changed · +2 lines · +72 tokens per session f1bad391d404
  4. 1mo ago Changed · +1 lines · +81 tokens per session 32ac52d229db
  5. 2mo ago First seen · 200 lines · 2,763 tokens per session scan A 4fffbe1ec465

Subscribe to this mod's changes

nui CLAUDE.md is an instructions file published in the GitHub repository plmbr/nui (8 stars, last pushed 1mo ago), licensed MIT. It adds 3,068 tokens to every session, about $0.0123 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,750 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens