substack-gateway-oss: Instructions file for Claude Code

CLAUDE.md

substack-gateway-oss CLAUDE.md is an instructions file for Claude Code from jakub-k-slys/substack-gateway-oss. It costs 2,530 tokens per session, scanned A, original, MIT.

Repository instructions for the Substack Gateway OSS project, a codebase that provides access to Substack through an API and MCP endpoints. They document how to install, run, check, test, and build the project.

In plain words
What is it for?
Use them when changing this repository to find its development commands, linting and type-checking steps, unit tests, integration tests, and build process.
Why use it?
They give a coding agent the project's expected commands and validation steps, reducing mistakes caused by using the wrong tools or checks.

Instructions file for Claude Code

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

This is jakub-k-slys/substack-gateway-oss's own configuration. It tells Claude Code how to work on substack-gateway-oss 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 substack-gateway-oss configures →

Reuse

Borrowing it

Nothing to install: this file belongs to jakub-k-slys/substack-gateway-oss. 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/jakub-k-slys/substack-gateway-oss/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/jakub-k-slys/substack-gateway-oss

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 substack-gateway-oss CLAUDE.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/jakub-k-slys/substack-gateway-oss/claude-md"><img src="https://agentmods.dev/badge/instructions/jakub-k-slys/substack-gateway-oss/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 2,530 This file is loaded in full into every session.
When invoked 2,530 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.02530 $0.02530
Opus 5 $0.01265 $0.01265
Sonnet 5 $0.00506 $0.00506
Haiku 4.5 $0.00253 $0.00253

Measured today against content hash 0eed4cbab7bd, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

substack-gateway-oss 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 today.

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 · 171 lines

How it starts

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

Commands

# Install dependencies (dev included, all workspace members)
uv sync --all-packages --dev

# Run the server (dev mode with reload)
uv run python -m substack_gateway.main

# Lint
uv run ruff check .

# Format check / fix
uv run ruff format --check .
uv run ruff format .

# Type-check
uv run ty check .

# Unit tests (pytest)
uv run pytest packages/gateway_oss/tests/
uv run pytest packages/gateway_drafts/tests/
uv run pytest packages/gateway_stats/tests/

# Run a single test file
uv run pytest packages/gateway_oss/tests/test_markdown.py

# BDD integration tests (behave)
uv run behave packages/gateway_oss/features/

# Run a single feature file
uv run behave packages/gateway_oss/features/api/notes.feature

# Build all workspace packages (shell + gateway_core + every domain trio)
uv build --all-packages

When introducing changes, validate them before finishing the task. Prefer targeted runs first, but the expected OSS validation set is:

  • uv run ruff check .
  • uv run ruff format --check .
  • uv run ty check .
  • uv build --all-packages
  • uv run pytest
  • uv run behave packages/gateway_oss/features/

Before committing or pushing, always run the relevant lint, format, type-check, and test commands for the touched area. Do not skip validation just because the change looks small.

Commit and PR titles must use Conventional Commits / semver-style prefixes such as feat:, fix:, chore:, docs:, refactor:, test:, or ci:. Prefer the narrowest correct prefix and keep the subject concise and imperative. For breaking changes, use Conventional Commits semver signaling with ! in the type or scope, and/or include a BREAKING CHANGE: footer in the commit body.

Repository layout

This repository is a uv workspace. The root is a thin shell package (substack-gateway, source in src/substack_gateway/) that composes the Starlette app; functionality is provided by per-domain packages under packages/.

Read the full file on GitHub · 171 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. today Changed · +88 tokens per session 0eed4cbab7bd
  2. yesterday Changed · +29 lines · +720 tokens per session 64ed92f81e3c
  3. 9d ago First seen · 142 lines · 1,722 tokens per session scan A d28814038cbe

Subscribe to this mod's changes

substack-gateway-oss CLAUDE.md is an instructions file published in the GitHub repository jakub-k-slys/substack-gateway-oss (26 stars, last pushed today), licensed MIT. It adds 2,530 tokens to every session, about $0.0127 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

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

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 3,735 tokens