atlas AGENTS.md

A repository instruction file that tells coding agents how to work on the Atlas PHP package. It defines required reading, project rules, and approval gates before changes are made.

In plain words
What is it for?
Use it when working in the atlas-php/atlas repository to find the required knowledge files, understand the technology stack, and follow the project's development process.
Why use it?
It gives agents the project's context and constraints before they edit code. This helps protect the package's public API and avoid changes that would burden applications using it.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/atlas-php/atlas/agents-md
Clone the repo
git clone --depth 1 https://github.com/atlas-php/atlas

Made for: Codex, OpenCode.

Per session 4,577 This file is loaded in full into every session.
When invoked 4,577 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.04577 $0.04577
Opus 5 $0.02289 $0.02289
Sonnet 5 $0.00915 $0.00915
Haiku 4.5 $0.00458 $0.00458

Measured 2d ago against content hash 5471f66def47, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

atlas 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 2d 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 · 391 lines

How it starts

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

AGENTS

Rules for every agent working in this repository. These rules are law; where they conflict with your general habits, this file wins.

This is an open-source Laravel package — a unified AI SDK (Atlas v3) that owns its own provider layer. Everything here ships into strangers' applications: the public API is a contract, every dependency is an imposition on every consumer, and the documentation is the product's front door. The what & why lives in .knowledge/BRIEF.md; the knowledge map is .knowledge/README.md. This file defines how you build here.

Before you work

Load light; pull depth only when the task needs it.

  1. Always read first: .knowledge/BRIEF.md (what & why), .knowledge/CODEMAP.md (where things are), .knowledge/MEMORY.md (current friction). .knowledge/README.md maps the rest.
  2. On demand, when the task enters an area: .knowledge/prd/ (ratified contracts — source of truth), .knowledge/prd-drafts/ (proposals), .knowledge/research/ + .knowledge/references/ (prior art, visual targets), .knowledge/guides/ (how to write each doc + project how-tos).
  3. How work flows: research/ -> prd-drafts/ -> prd/; a prd/ contract never cites a draft. New guaranteed behavior is a prd/ row backed by a test — cite its R-<AREA>-<n> in the code. Follow a doc's guide before writing or modifying it, and keep docs true in the same task. Run python3 .knowledge/scripts/doc-lint .knowledge before finishing; scratch -> .knowledge/tmp/.
  4. Read every file before editing it; search before writing new logic — reuse, extend, refactor.
  5. When the user raises a concern, investigate before contradicting — evidence, not a hunch.
  6. Read the relevant VitePress documentation before working on any module. Consumer docs are the source of truth — they override all assumptions.

Hard gates — require explicit approval

  • Persisted state. Any change to schema, stored data, or migrations is confirmed first.
  • Dependencies. Do not add, remove, or major-version-bump a package without approval.
  • Deletions. Do not delete files outside the task's immediate scope without approval.
  • Commits. Do not commit or push unless told to.
  • This file. Never modify AGENTS.md without approval; when approved, follow .knowledge/guides/docs-agents.md. If a rule seems wrong or missing, raise it.

Read the full file on GitHub · 391 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. 2d ago First seen · 391 lines · 4,577 tokens per session scan A 5471f66def47

Subscribe to this mod's changes

atlas AGENTS.md is an instructions file published in the GitHub repository atlas-php/atlas (54 stars, last pushed 1mo ago), licensed MIT. It adds 4,577 tokens to every session, about $0.0229 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

best-of-Agent-Harnesses CLAUDE.md

Claude Code instructions for RyanAlberts/best-of-Agent-Harnesses, covering repo notes for ai coding agents, commit identity (required), branching and pushing (required), verifying contribution credit (required) and how the list is generated.

RyanAlberts/best-of-Agent-Harnesses · 1,177 tokens

hindsight CLAUDE.md

Instructions for vectorize-io/hindsight, covering claude.md, project overview, development commands, local development (api + ui) and start both api server and control plane ui.

vectorize-io/hindsight · 4,846 tokens

codedb AGENTS.md

AGENTS.md instructions for justrach/codedb, covering codedb agent guidelines, what codedb is (and isn't), review guidelines, pre-merge verification and security-sensitive areas.

justrach/codedb · 509 tokens

claude-code-settings copilot-instructions.md

Instructions for feiskyer/claude-code-settings, covering claude.md, environment setup, required dependencies, configuration and skills.

feiskyer/claude-code-settings · 649 tokens

agentor copilot-instructions.md

Instructions for CelestoAI/agentor: Read AGENTS.md in the repository root. It is the single source of contributor guidance for this project — architecture, development setup, code style, testing, and CI — and applies to Copilot exactly as written.

CelestoAI/agentor · 141 tokens

pi CLAUDE.md

Instructions for share-skills/pi, covering 强制, 内部目标(不可写入公开文件), 跑分规范 and eval 驱动优化规则.

share-skills/pi · 409 tokens