Getting it into your agent
One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.
npx agentmods add instructions/mbadran/headlights/agents-mdgit clone --depth 1 https://github.com/mbadran/headlightsWhat 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 | $0.03212 | $0.03212 |
| Opus 5 | $0.01606 | $0.01606 |
| Sonnet 5 | $0.00642 | $0.00642 |
| Haiku 4.5 | $0.00321 | $0.00321 |
Grade A, and why
headlights AGENTS.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 2d 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.
How it starts
The opening of the file, as written. The whole thing — 340 lines — stays where its author put it; the contents beside it link to each section on GitHub.
AGENTS — Developer & AI-Agent Guide for headlights.nvim
This file is the canonical reference for anyone (human or AI) working on this codebase. Read it fully before making changes.
What this project is
headlights.nvim is a modern Neovim Lua rewrite of the original headlights.vim plugin.
It is a plugin browser: it discovers every loaded Neovim plugin and shows what each one contributes — commands, key mappings, abbreviations, functions, highlight groups, and source files — organised by plugin rather than as flat global lists.
Two display modes:
- Floating popup — hierarchical, interactive (Plugins → Categories → Items).
Used automatically in GUI frontends (Neovide, nvui, …), or forced with
:Headlights popup. - Buffer display — formatted scratch buffer in a vsplit
(
headlights://plugins). Default in terminal Neovim, or forced with:Headlights buffer.
A CLI driver at bin/headlights runs the same pipeline headlessly and
writes output to stdout. CI, the smoke test, and Docker all use it.
Repository layout
lua/headlights/
init.lua Public API: setup(), open()
config.lua Options with defaults (incl. extra_plugin_dirs)
collector.lua Live data snapshot from Neovim APIs
bundler.lua Groups scripts into bundles; attributes commands/maps via sid
ui.lua GUI detection + UI routing
ui/
popup.lua Floating-window hierarchical menu
buffer.lua Scratch-buffer display (text / markdown / json)
log.lua Structured logging + performance timing
health.lua :checkhealth headlights
plugin/
headlights.lua Entry point: guards, version check, user commands
bin/
headlights Shell wrapper around `nvim -l bin/headlights.lua`
headlights.lua Headless entrypoint: collector → bundler → renderer → stdout
tests/
minimal_init.lua Bootstraps mini.test for headless test runs
test_config.lua Unit tests — config defaults & overrides
test_collector.lua Live-API tests for the collector
test_bundler.lua Pure-logic tests (incl. extra_plugin_dirs)
test_ui_buffer.lua Buffer renderer + open() tests
test_ui_popup.lua Popup build_menu_lines + open() tests
test_integration.lua Real-fixture before/after end-to-end tests
fixtures/test_plugin.vim Minimal fake plugin used by integration tests
smoke/smoke.sh Single end-to-end smoke test (bin/headlights)
docker/
Dockerfile Ubuntu 24.04 + Neovim from the official tarball
scripts/
session-start.sh Print start-of-session status summary
session-end.sh Run quality gates + dump session summary
docker-test.sh Build image and run smoke (or any command)
doc/
headlights-nvim.txt Vim/Neovim help (`:help headlights`)
.github/workflows/
ci.yml GitHub Actions — smoke + tests + lint
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.
- 2d ago First seen · 340 lines · 3,212 tokens per session scan A 283bce113815
headlights AGENTS.md is an instructions file published in the GitHub repository mbadran/headlights (88 stars, last pushed 4mo ago), licensed MIT. It adds 3,212 tokens to every session, about $0.0161 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.
Other instructions, from other repositories
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.
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).
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.
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.
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).
next.js AGENTS.md
Instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.