speckit-companion: Instructions file for Claude Code

CLAUDE.md

speckit-companion CLAUDE.md is an instructions file for Claude Code from alfredoperez/speckit-companion. It costs 1,429 tokens per session, scanned A, original, MIT.

Repository instructions for the SpecKit Companion project, a VS Code extension that helps AI assistants work from written specifications, plans, and task lists. They also cover a separately versioned spec-kit extension in the same repository.

In plain words
What is it for?
Use them when working on documentation, architecture, captured project context, viewer states, sidebars, templates, visual assets, or release references.
Why use it?
They point contributors to the right documentation and record project-specific details that are easy to miss when changing the code.

Instructions file for Claude Code

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

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

Reuse

Borrowing it

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

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 speckit-companion CLAUDE.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/alfredoperez/speckit-companion/claude-md"><img src="https://agentmods.dev/badge/instructions/alfredoperez/speckit-companion/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,429 This file is loaded in full into every session.
When invoked 1,429 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.01429 $0.01429
Opus 5 $0.00714 $0.00714
Sonnet 5 $0.00286 $0.00286
Haiku 4.5 $0.00143 $0.00143

Measured 6d ago against content hash 78f11735f529, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-11, from the pricing page.

Security

Grade A, and why

speckit-companion 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 6d 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 · 55 lines

How it starts

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

CLAUDE.md

SpecKit Companion is a VS Code extension that gives AI assistants (terminal CLIs, IDE chat, the Claude Code panel) visual spec-driven development: specs (spec/plan/tasks), steering docs, and the Companion pipeline. The repo also ships a second, independently-versioned spec-kit extension under speckit-extension/. Provider list: README "Supported AI Providers".

Where things are documented

Read the matching doc instead of re-deriving from code:

  • docs/doc-sync.mddocs are part of the change, not a follow-up. Which doc each area maps to, the feature → README section map, the per-release checklist, changelog voice. Consult before finishing any user-facing change.
  • docs/architecture.md — structure and module map.
  • docs/capture-and-timing.md + docs/spec-context-schema.md — how .spec-context.json gets captured, and its schema (read-then-merge writes; transitions[] is append-only).
  • docs/viewer-states.md, docs/sidebar.md, docs/template-profiles.md — viewer state machine, sidebar reference, pipeline/workflow presets.
  • docs/visual-assets.md: how docs images and README GIFs are made and when to regenerate them. Everything in docs/screenshots/generated/ is a build artifact of scripts/capture-docs-images.mjs (Storybook capture stories + Teamboard fixtures); the GIFs render from media/feature-clips/ compositions. Any webview UI, styling, token, or fixture change makes them stale: regenerate, never hand-edit.
  • .claude/review-checklist.md — webview/CSS correctness invariants review scans for (.sr-only vs hidden, ellipsis trio, Preact string styles, etc.).
  • speckit-extension/docs/publishing.md — spec-kit extension release flow.

Gotchas

Two extensions, two sets of docs

The two extensions each have their own README, CHANGELOG, version, release flow, and tag namespace: VS Code extension = root README.md/CHANGELOG.md, package.json version, /publishv* tag; spec-kit extension = speckit-extension/README.md/CHANGELOG.md, extension.yml extension.version, /publish-speckit-extspeckit-ext-v* tag (/publish-both runs both). A change under speckit-extension/ updates its docs, never the root ones (and vice-versa); overlapping entries for a feature spanning both halves are expected. Never edit .specify/extensions/companion/CHANGELOG.md — generated, gitignored, overwritten on install. The release flow owns the version bump — feature branches do not. A branch touching speckit-extension/ writes under ## [Unreleased] and leaves extension.yml version, the README badge, and publishing.md alone; bumping on a branch is what produces version/changelog/badge drift.

Read the full file on GitHub · 55 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. 6d ago Changed · +42 tokens per session 78f11735f529
  2. 12d ago First seen · 55 lines · 1,387 tokens per session scan A afb3cd560866

Subscribe to this mod's changes

speckit-companion CLAUDE.md is an instructions file published in the GitHub repository alfredoperez/speckit-companion (90 stars, last pushed yesterday), licensed MIT. It adds 1,429 tokens to every session, about $0.0071 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.

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

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

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