GitShelf: Instructions file for Claude Code

CLAUDE.md

GitShelf CLAUDE.md is an instructions file for Claude Code from Praeviso/GitShelf. It costs 1,533 tokens per session, scanned A, original, MIT.

Project-specific instructions for GitShelf, a serverless publishing site that turns uploaded PDFs, Markdown files, or ZIP archives into books, documents, or websites using a browser and GitHub Actions.

In plain words
What is it for?
Use them when developing or testing GitShelf, including starting its Vite development server, building or previewing the site, and running its Vitest tests.
Why use it?
They give an agent the project's purpose, development commands, testing commands, and a precaution for avoiding conflicts with already-running local servers.

Instructions file for Claude Code

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

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

Reuse

Borrowing it

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

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

README.md
[![agentmods](https://agentmods.dev/badge/instructions/praeviso/gitshelf/claude-md.svg)](https://agentmods.dev/instructions/praeviso/gitshelf/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/praeviso/gitshelf/claude-md"><img src="https://agentmods.dev/badge/instructions/praeviso/gitshelf/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,533 This file is loaded in full into every session.
When invoked 1,533 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.01533 $0.01533
Opus 5 $0.00766 $0.00766
Sonnet 5 $0.00307 $0.00307
Haiku 4.5 $0.00153 $0.00153

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

Security

Grade A, and why

GitShelf 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 · 118 lines

How it starts

The opening of the file, as written. The whole thing — 118 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.

What This Project Is

GitShelf is a serverless content shelf on GitHub Pages. Users upload PDFs, Markdown files, or ZIP archives through the browser admin panel, GitHub Actions processes them into books, documents, or static sites, and the result is a GitHub-hosted reading and publishing site. No backend server — everything runs in GitHub Actions and the browser.

Commands

Development

npm run dev          # Vite dev server (serves src/ with docs/ data via middleware)
npm run build        # Build frontend to docs/ (generated docs/index.html + docs/assets stay ignored)
npm run preview      # Preview production build

Before starting a dev server (npm run dev, npm run preview, or any long-running service), check if the port is already in use and kill the existing process first:

# Check and kill existing process on port 5173 (or whichever port)
lsof -ti:5173 | xargs kill -9 2>/dev/null; npm run dev

Testing

npm test             # Vitest: components, hooks, lib tests (jsdom)
npm run test:watch   # Vitest watch mode
npm run test:frontend  # Frontend behavior tests
python -m unittest discover -s tests/scripts -v  # Python pipeline tests

CI

The test.yml workflow runs both Python and JS tests. The content-processing workflows handle uploads and conversions. deploy-pages.yml builds and deploys to GitHub Pages.

Architecture

Two codebases, one repo

  • Frontend (Preact + Vite): src/ builds to generated docs/index.html + docs/assets/. Those build artifacts are ignored by Git and recreated in the Pages deploy workflow. Renders books, articles, and site cards, with markdown-it, syntax highlighting, and KaTeX support.
  • Pipeline (Python 3.11): scripts/ runs in GitHub Actions. Processes PDFs, Markdown files, and ZIP archives into typed content directories and regenerates catalog data.

Read the full file on GitHub · 118 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 First seen · 118 lines · 1,533 tokens per session scan A ce97b27ee2fb

Subscribe to this mod's changes

GitShelf CLAUDE.md is an instructions file published in the GitHub repository Praeviso/GitShelf (2 stars, last pushed 4mo ago), licensed MIT. It adds 1,533 tokens to every session, about $0.0077 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-31.

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

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

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

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,104 tokens