ably-cli: Instructions file for Codex

AGENTS.md

ably-cli AGENTS.md is an instructions file for Codex, OpenCode from ably/ably-cli. It costs 7,019 tokens per session, scanned A, original, Apache-2.0.

Project instructions for Ably CLI, a command-line package for working with Ably services.

In plain words
What is it for?
Use them when modifying commands, services, utilities, tests, documentation, or build workflows in the Ably CLI repository.
Why use it?
They define the required preparation, documentation, linting, and testing checks so changes are verified consistently.

Instructions file for CodexOpenCode

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

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

Needs its repository: it reads a path above its own folder, which exists only inside the repository. The line is import { productApiFlags, clientIdFlag, durationFlag, rewindFlag } from "../../flags.js";.

Reuse

Borrowing it

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

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/ably/ably-cli/agents-md"><img src="https://agentmods.dev/badge/instructions/ably/ably-cli/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 7,019 This file is loaded in full into every session.
When invoked 7,019 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.07019 $0.07019
Opus 5.5 $0.02808 $0.02808
Sonnet 5.5 $0.01404 $0.01404
Haiku 4.5 $0.00702 $0.00702

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

Security

Grade A, and why

ably-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 · 371 lines

How it starts

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

AGENTS.md - Ably CLI

Mandatory Workflow

Run these IN ORDER for EVERY change:

pnpm prepare        # 1. Build + update manifest
pnpm generate-doc  # 2. Regenerate docs (gitignored)
pnpm exec eslint .  # 3. Lint (MUST be 0 errors)
pnpm test:unit      # 4. Test (at minimum)
pnpm test:tty       # 5. TTY tests (local only, skip in CI)
                    # 6. Update docs if needed

If you skip these steps, the work is NOT complete.

Project Context

This is the Ably CLI npm package (@ably/cli), built with the oclif framework.

.
├── src/
│   ├── commands/      # CLI commands (oclif)
│   ├── services/      # Business logic
│   ├── utils/         # Utilities
│   └── base-command.ts
├── test/
│   ├── unit/          # Fast, mocked
│   ├── integration/   # Multi-component, mocked external services
│   ├── e2e/           # Full scenarios against real Ably
│   └── helpers/       # runCommand(), MockConfigManager, etc.
├── docs/              # Project docs (Testing.md, Project-Structure.md, etc.)
└── package.json       # Scripts defined here

Common Pitfalls - DO NOT DO THESE

  1. Skip tests - Only skip with documented valid reason
  2. Use _ prefix for unused variables - Remove the code instead
  3. Leave debug code - Remove ALL console.log, DEBUG_TEST, test-*.mjs
  4. Use // eslint-disable - Fix the root cause
  5. Remove tests without asking - Always get permission first
  6. NODE_ENV - To check if the CLI is in test mode, use the isTestMode() helper function.
  7. process.exit - When creating a command, use this.exit() for consistent test mode handling.
  8. console.log / console.error - In commands, always use this.log() (stdout) for data/results and the logging helpers (this.logProgress(), this.logSuccessMessage(), this.logListening(), this.logHolding(), this.logWarning()) for status messages. console.* bypasses oclif and can't be captured by tests.
  9. Use Args.string() for primary entity identifiers - If the value is "what is being acted on" (name, ID, channel), represent it as a positional Args.string(), not a Flags.string(). Primary entity identifiers should always use camelCase.

Read the full file on GitHub · 371 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. 2mo ago First seen · 371 lines · 7,019 tokens per session scan A 3fd616aad3db

Subscribe to this mod's changes

ably-cli AGENTS.md is an instructions file published in the GitHub repository ably/ably-cli (5 stars, last pushed 2d ago), licensed Apache-2.0. It adds 7,019 tokens to every session, about $0.0281 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

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,750 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens