gateway: Instructions file for Claude Code

CLAUDE.md

gateway CLAUDE.md is an instructions file for Claude Code from Portkey-AI/gateway. It costs 844 tokens per session, scanned A, original, MIT.

Repository instructions for Claude Code, an AI coding assistant, explaining how to develop the Portkey AI Gateway, software that sends requests to different large language model services through one system.

In plain words
What is it for?
Starting the gateway, building it, testing its main code and plugins, checking formatting, and deploying it to Cloudflare Workers or Node.js.
Why use it?
It gives the assistant the project’s commands for development, testing, formatting, building, and deployment instead of leaving those choices unclear.

Instructions file for Claude Code

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

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

About the project

Portkey AI Gateway is an open-source service that gives applications one interface for routing requests to language, vision, audio, and image models. Teams use it to connect AI applications to many model providers while handling retries, fallbacks, load balancing, and guardrails.

Portkey-AI/gateway · 12,920 stars · on GitHub · portkey.ai

Reuse

Borrowing it

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

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

README.md
[![agentmods](https://agentmods.dev/badge/instructions/portkey-ai/gateway/claude-md.svg)](https://agentmods.dev/instructions/portkey-ai/gateway/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/portkey-ai/gateway/claude-md"><img src="https://agentmods.dev/badge/instructions/portkey-ai/gateway/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 844 This file is loaded in full into every session.
When invoked 844 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.00844 $0.00844
Opus 5 $0.00422 $0.00422
Sonnet 5 $0.00169 $0.00169
Haiku 4.5 $0.00084 $0.00084

Measured 8d ago against content hash 9e4cf61d38e7, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

gateway 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 8d 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 · 95 lines

How it starts

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

This is the Portkey AI Gateway - a fast, reliable AI gateway that routes requests to 250+ LLMs with sub-1ms latency. It's built with Hono framework for TypeScript/JavaScript and can be deployed to multiple environments including Cloudflare Workers, Node.js servers, and Docker containers.

Development Commands

Core Development

  • npm run dev - Start development server using Wrangler (Cloudflare Workers)
  • npm run dev:node - Start development server using Node.js
  • npm run build - Build the project for production
  • npm run build-plugins - Build the plugin system

Testing

  • npm run test:gateway - Run tests for the main gateway code (src/)
  • npm run test:plugins - Run tests for plugins
  • jest src/ - Run specific gateway tests
  • jest plugins/ - Run specific plugin tests

Code Quality

  • npm run format - Format code with Prettier
  • npm run format:check - Check code formatting
  • npm run pretty - Alternative format command

Deployment

  • npm run deploy - Deploy to Cloudflare Workers
  • npm run start:node - Start production Node.js server

Architecture

Core Components

Main Application (src/index.ts)

  • Hono-based HTTP server with middleware pipeline
  • Handles multiple AI provider integrations
  • Routes: /v1/chat/completions, /v1/completions, /v1/embeddings, etc.

Provider System (src/providers/)

  • Modular provider implementations (OpenAI, Anthropic, Azure, etc.)
  • Each provider has standardized interface: api.ts, chatComplete.ts, embed.ts
  • Provider configs define supported features and transformations

Middleware Pipeline

  • requestValidator - Validates incoming requests
  • hooks - Pre/post request hooks
  • memoryCache - Response caching
  • logger - Request/response logging
  • adminAuth - Node-only local UI session auth for /public/* login endpoints and /log/stream
  • portkey - Core Portkey-specific middleware for routing, guardrails, etc.

Read the full file on GitHub · 95 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. 8d ago First seen · 95 lines · 844 tokens per session scan A 9e4cf61d38e7

Subscribe to this mod's changes

gateway CLAUDE.md is an instructions file published in the GitHub repository Portkey-AI/gateway (12,920 stars, last pushed 3mo ago), licensed MIT. It adds 844 tokens to every session, about $0.0042 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

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

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

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

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