pulsar: Instructions file for Codex

AGENTS.md

pulsar AGENTS.md is an instructions file for Codex, OpenCode from apache/pulsar. It costs 1,656 tokens per session, scanned A, original, Apache-2.0.

A starting guide for coding assistants working in the Apache Pulsar repository. It explains which project documents to read, how licensing and human review apply, and which rules protect the codebase.

In plain words
What is it for?
Use it at the beginning of Apache Pulsar tasks to locate the right instructions for Java code, build changes, tests, and repository practices.
Why use it?
It prevents changes from violating Pulsar's contribution requirements or overlooking its performance, concurrency, and compatibility concerns.

Instructions file for CodexOpenCode ✓ vendor

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions Claude Code; mentions AGENTS.md; mentions Codex.

This is apache/pulsar's own configuration. It tells Codex and OpenCode how to work on pulsar 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 pulsar configures →

About the project

Apache Pulsar is a distributed messaging platform that moves messages between producers and consumers through pub-sub topics and queues. It is used for streaming, queuing, and other workloads that need scalable, durable message delivery. The catalogue includes instructions for working with Pulsar.

apache/pulsar · 15,355 stars · on GitHub · pulsar.apache.org

Reuse

Borrowing it

Nothing to install: this file belongs to apache/pulsar. 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/apache/pulsar/master/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/apache/pulsar

Made for: Codex, OpenCode.

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 pulsar AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/apache/pulsar/agents-md/github.svg)](https://agentmods.dev/instructions/apache/pulsar/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/apache/pulsar/agents-md"><img src="https://agentmods.dev/badge/instructions/apache/pulsar/agents-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 pulsar AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/apache/pulsar/agents-md"><img src="https://agentmods.dev/badge/instructions/apache/pulsar/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,656 This file is loaded in full into every session.
When invoked 1,656 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.01656 $0.01656
Opus 5.5 $0.00662 $0.00662
Sonnet 5.5 $0.00331 $0.00331
Haiku 4.5 $0.00166 $0.00166

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

Security

Grade A, and why

pulsar AGENTS.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 27d 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.

AGENTS.md · 97 lines

How it starts

The opening of the file, as written. The whole thing — 97 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Agent guide for Apache Pulsar

Supplemental guidance for AI coding assistants (Claude Code, Copilot, Cursor, Gemini, Codex, Aider, and similar tools) working in this repository. Keep this file short — it is a router. The detail lives in the human-facing docs linked below; read the one that fits your task rather than pulling everything into context up front.

Apache Pulsar is a distributed pub-sub messaging and streaming platform. The codebase is performance-critical, heavily asynchronous, and concurrency-sensitive. Prioritize correctness, thread safety, performance, maintainability, and backward compatibility.

Licensing and provenance (read first)

Apache Pulsar is licensed under the Apache License 2.0, and all contributions must meet the ASF's Generative Tooling guidance:

  • A human is in the loop and is accountable. Every pull request and every security report must be submitted by a human contributor who has reviewed and verified the change and takes responsibility for it. Fully autonomous agents (e.g. OpenClaw-style bots) opening PRs or filing reports on their own are not acceptable — the AI assists, the human is accountable.
  • Don't introduce code of incompatible or unknown provenance. Never copy verbatim from GPL/AGPL/LGPL, proprietary, or unlicensed sources (including Stack Overflow / blog / forum snippets of unclear licensing), and don't use a tool whose terms restrict the output inconsistently with open source. Reimplement from specifications or Apache-compatible sources, and follow the ASF 3rd Party Licensing Policy.
  • Every new source file needs the ASF license header (Spotless enforces this — copy the form from an existing .java file).
  • Consider attributing AI assistance. When AI tooling assisted on a change, consider adding an Assisted-by: <tool/version> commit trailer (the default, since a human still does the final review); Generated-by: <tool/version> is for minimally-modified generated output.

Read the full file on GitHub · 97 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. 27d ago Changed · +26 tokens per session fac9ce587a4e
  2. 1mo ago Changed · +8 lines · +140 tokens per session a1b666df8fc9
  3. 1mo ago Changed · +1 lines · +31 tokens per session 229c4e16b54c
  4. 2mo ago First seen · 88 lines · 1,459 tokens per session scan A 1883b22f54c5

Subscribe to this mod's changes

pulsar AGENTS.md is an instructions file published in the GitHub repository apache/pulsar (15,355 stars, last pushed yesterday), licensed Apache-2.0. It adds 1,656 tokens to every session, about $0.0066 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-30.

Related

Other instructions, from other repositories

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 · 9,715 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,461 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 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 · 4,261 tokens