What is deckle CLAUDE.md?

Project instructions for Deckle, a PDF-generation API that turns HTML or template data into PDF files. They describe its pnpm monorepo, development commands, database tasks, dashboard, and tests; a monorepo is one repository containing multiple related projects.

Use them to install dependencies, run the API and dashboard, build the projects, update the database, and run all or selected tests.

They give a coding agent the project context and commands needed to work consistently in the repository.

How Yoshyaes/deckle configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to Yoshyaes/deckle. 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/Yoshyaes/deckle/master/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/Yoshyaes/deckle

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/yoshyaes/deckle/claude-md/github.svg)](https://agentmods.dev/instructions/yoshyaes/deckle/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/yoshyaes/deckle/claude-md"><img src="https://agentmods.dev/badge/instructions/yoshyaes/deckle/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/yoshyaes/deckle/claude-md"><img src="https://agentmods.dev/badge/instructions/yoshyaes/deckle/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 2,344 This file is loaded in full into every session.

When invoked 2,344 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.

Model	Per session	Once invoked
Fable 5.1	$0.02344	$0.02344
Opus 5.5	$0.00938	$0.00938
Sonnet 5.5	$0.00469	$0.00469
Haiku 4.5	$0.00234	$0.00234

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

Security

Grade A, and why

deckle 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 · 157 lines

How it starts

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

Project Overview

Deckle is a PDF generation API ("Stripe for PDFs"). It accepts HTML or template data and returns pixel-perfect PDFs. The codebase is a pnpm monorepo with Turborepo orchestration.

Commands

pnpm install                    # Install all workspace dependencies
pnpm dev                        # Run all dev servers (API :3000, Dashboard :3001)
pnpm build                      # Build all packages via Turborepo

# API server
pnpm --filter @deckle/api dev        # API dev server with hot reload
pnpm --filter @deckle/api build      # Build API
pnpm --filter @deckle/api db:push    # Push schema to database
pnpm --filter @deckle/api db:generate # Generate migration files
pnpm --filter @deckle/api db:migrate  # Run migrations

# Testing
cd apps/api && npx vitest run           # Run all 36 API tests
cd apps/api && npx vitest run src/__tests__/generate-validation.test.ts  # Single test file

# Dashboard
pnpm --filter @deckle/dashboard dev   # Next.js dev on port 3001
pnpm --filter @deckle/dashboard build # Build dashboard

# TypeScript SDK
pnpm --filter @getdeckle/sdk build           # Build SDK (ESM + CJS + types)
pnpm --filter @getdeckle/sdk dev             # Watch mode build

# React component library
cd packages/react && npm run build      # Build @deckle/react

# Playwright (required once before API dev)
cd apps/api && npx playwright install chromium

# Docker (self-hosted)
docker compose -f docker-compose.selfhost.yml up -d

Architecture

Monorepo layout (pnpm-workspace.yaml covers apps/* and packages/*):

apps/api — Hono API server. Playwright renders HTML→PDF. Drizzle ORM for PostgreSQL. Redis for rate limiting + BullMQ job queue. Multi-provider storage (local/R2/S3/GCS).
apps/dashboard — Next.js 14 App Router. Clerk auth. Tailwind CSS with dark theme (#0A0A0B bg, #F97316 accent). DM Sans body font, JetBrains Mono for code.
packages/sdk-typescript — npm package deckle. Dual ESM/CJS build via tsup. Deckle class with generate(), fromTemplate(), fromReact(), batch(), and templates.* namespace.
packages/sdk-python — pip package deckle. Mirrors TS SDK API. Uses httpx + Pydantic v2.
packages/sdk-go — Go module github.com/Yoshyaes/deckle/packages/sdk-go. Stdlib net/http + functional options. Context-based API.
packages/sdk-ruby — Ruby gem deckle. Uses Faraday HTTP client. Idiomatic Ruby API.
packages/react — @deckle/react component library (Document, Page, Header, Footer, Table, Grid, Watermark, Barcode, Signature).
packages/mcp-server — MCP server for AI agent integration (Claude Desktop, Cursor, Claude Code). 7 tools.
docs/ — Mintlify documentation site. Framework guides for Next.js, Express, FastAPI, Django, Rails.
public/ — AI discoverability: llms.txt, llms-full.txt.

Read the full file on GitHub · 157 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.

2mo ago First seen · 157 lines · 2,344 tokens per session scan A a60ef9846ddf

Subscribe to this mod's changes

deckle CLAUDE.md is an instructions file published in the GitHub repository Yoshyaes/deckle (2 stars, last pushed 3mo ago), licensed MIT. It adds 2,344 tokens to every session, about $0.0094 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.

deckle CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
deckle CLAUDE.mdYoshyaes/deckle	Instructions file	2	3mo ago	MIT	A	2,344	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

deckle: Instructions file for Claude Code