agent-ready-cli: Instructions file for Codex

AGENTS.md

agent-ready-cli AGENTS.md is an instructions file for Codex, OpenCode from AlexanderKorchyk/agent-ready-cli. It costs 363 tokens per session, scanned A, original, MIT.

A project guide for agent-ready-cli, a Python command-line tool that scans a local code repository and creates an AGENTS.md file for coding assistants.

In plain words
What is it for?
Use it when developing, testing, formatting, linting, or running agent-ready-cli.
Why use it?
It records the commands, coding conventions, testing rules, and repository layout needed to work consistently on the project.

Instructions file for CodexOpenCode

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

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

Reuse

Borrowing it

Nothing to install: this file belongs to AlexanderKorchyk/agent-ready-cli. 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/AlexanderKorchyk/agent-ready-cli/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/AlexanderKorchyk/agent-ready-cli

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 agent-ready-cli AGENTS.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/alexanderkorchyk/agent-ready-cli/agents-md"><img src="https://agentmods.dev/badge/instructions/alexanderkorchyk/agent-ready-cli/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 363 This file is loaded in full into every session.
When invoked 363 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.00363 $0.00363
Opus 5.5 $0.00145 $0.00145
Sonnet 5.5 $0.00073 $0.00073
Haiku 4.5 $0.00036 $0.00036

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

Security

Grade A, and why

agent-ready-cli 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 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.

AGENTS.md · 50 lines

What it actually says

AGENTS.md

This file gives AI coding agents the project context and working rules for agent-ready-cli.

Project Overview

agent-ready-cli is a Python CLI that scans a local repository and generates a useful AGENTS.md file for AI development tools.

Development Commands

  • Install locally: python -m pip install -e ".[dev]"
  • Run tests: python -m pytest
  • Run lint: python -m ruff check .
  • Run formatter: python -m ruff format .
  • Run CLI: python -m agent_ready_cli --help

Code Style

  • Target Python 3.10+.
  • Use type annotations for public functions and dataclasses.
  • Keep modules focused and small.
  • Follow PEP 8 and Ruff defaults.
  • Prefer simple standard-library parsing unless a project dependency already provides a safer abstraction.

Testing Rules

  • Add or update tests for behavior changes.
  • Use tmp_path for filesystem tests.
  • Avoid tests that depend on network access or a developer's machine state.
  • Keep generated Markdown stable so it is easy to snapshot with assertions.

Repository Map

  • src/agent_ready_cli/: package source code.
  • tests/: unit tests and CLI tests.
  • .github/workflows/: CI and Codex review automation.

Agent Instructions

  • Do not overwrite an existing AGENTS.md in a target repo unless the user passes an explicit force option.
  • Keep generated output deterministic.
  • Do not introduce new runtime dependencies unless they materially improve CLI usability or parsing correctness.
  • Before finishing code changes, run python -m pytest and python -m ruff check ..
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. 2mo ago First seen · 50 lines · 363 tokens per session scan A 4179f30c4e51

Subscribe to this mod's changes

agent-ready-cli AGENTS.md is an instructions file published in the GitHub repository AlexanderKorchyk/agent-ready-cli (2 stars, last pushed 5mo ago), licensed MIT. It adds 363 tokens to every session, about $0.0015 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.

Related

agent-ready-cli AGENTS.md compared with instructions from other repositories

agent-ready-cli AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
agent-ready-cli AGENTS.mdAlexanderKorchyk/agent-ready-cliInstructions file25mo agoMITA363Codex, OpenCode
whichrules copilot-instructions.mdz35068037/whichrulesInstructions file53mo agoMITA21GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143kyesterdayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot