emberglow-keyboard: Instructions file for Claude Code

CLAUDE.md

emberglow-keyboard CLAUDE.md is an instructions file for Claude Code from emberglow-dev/emberglow-keyboard. It costs 1,647 tokens per session, scanned A, original, MIT.

Repository instructions for Emberglow, software that controls the lights on a Keychron Q10 keyboard based on Claude activity. They cover its command-line and web interfaces and document two versions of the keyboard's HID lighting protocol.

In plain words
What is it for?
Use them when changing keyboard control, lighting states, Claude Code hooks, signed webhooks, the Flask server, or the Emberglow command-line tool.
Why use it?
They call out hardware behavior that can make a failed command look successful, such as echoed packets that the keyboard ignores. This helps contributors preserve the required version handshake and correct packet format.

Instructions file for Claude Code

Written for Claude Code: UserPromptSubmit hook event. Also seen: mentions CLAUDE.md; mentions Claude Code.

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

Reuse

Borrowing it

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

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 emberglow-keyboard CLAUDE.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/emberglow-dev/emberglow-keyboard/claude-md"><img src="https://agentmods.dev/badge/instructions/emberglow-dev/emberglow-keyboard/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,647 This file is loaded in full into every session.
When invoked 1,647 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.01647 $0.01647
Opus 5.5 $0.00659 $0.00659
Sonnet 5.5 $0.00329 $0.00329
Haiku 4.5 $0.00165 $0.00165

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

Security

Grade A, and why

emberglow-keyboard 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 2mo 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 · 126 lines

How it starts

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

CLAUDE.md — working in the Emberglow repo

Guidance for Claude (and Claude Code) working in this codebase. Read this first.

What this is

Emberglow lights a Keychron Q10 based on Claude activity, over the VIA protocol (QMK raw HID). Two front ends share one lighting engine:

  • CLI (emberglow set <state>) — called by Claude Code hooks.
  • Flask server (emberglow serve) — receives Anthropic Managed Agents webhooks, verifies their HMAC signature, and drives the same engine.

Hard-won knowledge (read before touching keyboard.py)

The VIA lighting protocol has two incompatible dialects, and the Q10 speaks the older one. Always handshake the version first — never assume the dialect.

  • v3 (protocol version ≥ 11): set = [0x07, channel, value_id, data…], value IDs 1–4, RGB-matrix channel 3.
  • v2 (protocol version ≤ 10 — the Q10 reports 10): set = [0x07, value_id, data…], value IDs 0x80–0x83, no channel byte.

Both use command byte 0x07, and the firmware echoes every packet back even when it ignores it. So sending v3 packets to a v2 board looks perfect — clean echo, no error — while doing nothing, and reads return 0 on a visibly-lit board. The telltales that cracked this: reads were [0] on a glowing keyboard (brightness can't be 0 on a lit board), and the version line said 10 when v3 would be 11+.

keyboard.detect_dialect() reads version command 0x01 (the one packet identical across all VIA versions), picks v2/v3 framing, and _verify() does one read to confirm the reply echoes the request header. This runs before every command via Keyboard.apply(). Do not bypass it with hardcoded framing — that is the exact bug the next contributor would reintroduce. The original relay.py POC is v3-only and does not work on this board; it's kept for reference only.

A second trap: a probe that only changes the effect index is nearly invisible against whatever the board was already doing. emberglow probe forces full-brightness red on every step so each effect change is unmistakable.

Read the full file on GitHub · 126 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. 2mo ago First seen · 126 lines · 1,647 tokens per session scan A 149db34231b0

Subscribe to this mod's changes

emberglow-keyboard CLAUDE.md is an instructions file published in the GitHub repository emberglow-dev/emberglow-keyboard (10 stars, last pushed 3mo ago), licensed MIT. It adds 1,647 tokens to every session, about $0.0066 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