aspens copilot-instructions.md

A project guide for AspenKit, a command-line tool that scans a codebase and creates documentation that AI coding tools can use.

In plain words
What is it for?
Installing the tool, detecting a project's technologies, generating documentation, and synchronizing that documentation after code changes.
Why use it?
It explains the project's purpose, structure, setup, and documentation workflow so an AI agent can work consistently in the repository.

Instructions file for GitHub Copilot

Install

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.

agentmods
npx agentmods add instructions/aspenkit/aspens/copilot-instructions
Clone the repo
git clone --depth 1 https://github.com/aspenkit/aspens

Made for: GitHub Copilot.

Per session 1,361 This file is loaded in full into every session.
When invoked 1,361 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.01361 $0.01361
Opus 5 $0.00681 $0.00681
Sonnet 5 $0.00272 $0.00272
Haiku 4.5 $0.00136 $0.00136

Measured 2d ago against content hash 79b28c78ae94, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

aspens copilot-instructions.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.

.github/copilot-instructions.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.

Copilot Instructions

What This Project Does

aspens is a CLI tool that generates and maintains AI-ready documentation (skills and guidelines) for any codebase. It scans a repo's tech stack, then uses Claude to produce structured markdown "skill files" that Claude Code loads automatically when working in that codebase.

aspens scan                        # detect tech stack (current dir)
aspens doc init --dry-run          # preview generated skills
aspens doc init --mode chunked     # generate one domain at a time
aspens doc sync --commits 3        # update skills from last 3 commits
aspens doc sync --install-hook     # auto-sync on every commit

Project Setup

npm install   # installs commander, @clack/prompts, picocolors
npm link      # makes `aspens` available globally for testing

No build step. No test runner configured yet — tests/ is empty.

Architecture

bin/cli.js              # entrypoint — welcome screen + subcommands via commander
src/
  index.js              # barrel exports
  commands/
    scan.js             # pretty/JSON output of scanner results
    doc-init.js         # full pipeline: scan → mode select → Claude → write
    doc-sync.js         # diff-based skill updates + git hook installer
    add.js              # placeholder (Phase 4)
  lib/
    scanner.js          # deterministic tech stack detection (no LLM)
    context-builder.js  # assembles repo context (used by doc-sync, available for API mode)
    runner.js           # wraps `claude -p` CLI; prompt loading; output parsing; path sanitization
    skill-writer.js     # writes parsed {path, content} files to disk
  prompts/
    doc-init.md         # all-at-once init prompt (tool-first: "read before writing")
    doc-init-domain.md  # single domain skill prompt (for chunked mode)
    doc-init-claudemd.md # CLAUDE.md generation prompt
    doc-sync.md         # sync prompt (diff → skill updates)
    partials/           # skill-format.md, guideline-format.md, examples.md

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. 2d ago First seen · 126 lines · 1,361 tokens per session scan A 79b28c78ae94

Subscribe to this mod's changes

aspens copilot-instructions.md is an instructions file published in the GitHub repository aspenkit/aspens (96 stars, last pushed 17d ago), licensed MIT. It adds 1,361 tokens to every session, about $0.0068 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

Skill_Seekers CLAUDE.md

Instructions for yusufkaraaslan/Skill_Seekers, covering claude.md, project overview, essential commands, required before running tests or cli (src/ layout) and run all tests (never skip - all must pass before commits).

yusufkaraaslan/Skill_Seekers · 5,387 tokens

docs-to-pdf CLAUDE.md

Instructions for jean-humann/docs-to-pdf, covering claude development guide for docs-to-pdf, project overview, development environment setup, using mise (recommended) and install mise (if not already installed).

jean-humann/docs-to-pdf · 4,714 tokens

core copilot-instructions.md

Instructions for asdecided/core: These decisions are already accepted. Do not re-open or contradict them; ask the AsDecided MCP tools (getartifact, searchartifacts) for the full text before proposing a change that touches one.

asdecided/core · 3,534 tokens

backend.ai AGENTS.md

AGENTS.md instructions for lablup/backend.ai, covering ai coding agent guidelines, document structure (agents.md / knowledge.md), writing style, document index and absolute rules (global).

lablup/backend.ai · 1,864 tokens

alcove AGENTS.md

Instructions for epicsagas/alcove, covering claude.md, repository purpose, actual location, structure and karpathy 3-layer architecture.

epicsagas/alcove · 1,840 tokens

slideops CLAUDE.md

Instructions for glukicov/slideops, covering claude.md, what this repository is, commands, the demo deck's citations must still match this repo and the citation mechanism (the core idea).

glukicov/slideops · 1,321 tokens