cli AGENTS.md

A repository guide for Agora CLI, a command-line program for helping developers set up and use Agora. It explains the project layout, build and test commands, available commands, and machine-readable output.

In plain words
What is it for?
Use it when working on Agora CLI source code, regenerating its command documentation, inspecting its command tree, or checking JSON output and agent introspection.
Why use it?
It gives a coding agent the project-specific context needed to inspect, change, build, and test the CLI consistently.

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/agoraio/cli/agents-md
Clone the repo
git clone --depth 1 https://github.com/AgoraIO/cli

Made for: Codex, OpenCode.

Per session 3,447 This file is loaded in full into every session.
When invoked 3,447 The same file — it is already loaded in full.
Security scan A 2 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.03447 $0.03447
Opus 5 $0.01724 $0.01724
Sonnet 5 $0.00689 $0.00689
Haiku 4.5 $0.00345 $0.00345

Measured yesterday against content hash 68730bfa2265, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

cli AGENTS.md scanned grade A with 2 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 yesterday.

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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

curl -sSfL https://golangci-lint.run/install.sh \

Runs shell commandslowCapability

Expected in a hook, worth knowing in a rule or an instructions file.

2. `bin/agora.js` resolves `agoraio-cli-<platform>/bin/agora` and `spawnSync`s it with all args inherited
AGENTS.md · 274 lines

How it starts

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

Agent and Contributor Guide

Repo Purpose

This repository contains Agora CLI, the native CLI for Agora developer onboarding. It ships as a single binary with no runtime dependencies and is the primary distribution. The same binary is also published via npm as agoraio-cli (a thin shim that runs the native executable).

Quick Reference

Task Command
Build binary go build -o agora .
Run all tests go test ./...
Inspect full command tree ./agora --help --all
Machine-readable full command tree ./agora --help --all --json
Agent introspection artifact ./agora introspect --json
Machine-readable output Add --json to any command

Source Layout

main.go                     Entry point — wires the root command and calls Execute()
cmd/
  gendocs/                  Regenerates docs/commands.md from the live cobra tree
internal/cli/
  app.go                    App struct, Execute(), output-mode resolver, env snapshot
  commands.go               Root command tree; subcommand builders for auth/config/upgrade/etc.
  envelope.go               JSON envelope shape, exit-code plumbing, error helpers
  render.go                 Pretty output dispatch (renderResult, printBlock, printDoctor)
  paths.go                  Config / session / context paths, writeSecureJSON
  config.go                 appConfig type, defaults, env injection
  version.go                Build-time version vars, versionInfo, formattedVersion
  introspect.go             agora introspect + buildIntrospectionData (agent discovery contract)
  mcp.go                    agora mcp serve — JSON-RPC MCP tool dispatch
  open_targets.go           Canonical URLs for agora open (docs, Console, product docs)
  features.go               Product feature catalog (rtc/rtm/convoai) shared by doctor, introspect, init defaults
  cache.go                  Short-lived on-disk API caches (project list for shell completion)
  completion.go             Dynamic shell completion helpers
  upgrade.go                agora upgrade self-update logic (download, SHA-256, atomic rename)
  progress.go               NDJSON progress event emitter for long-running JSON-mode commands
  auth.go                   login / logout / whoami / auth status
  projects.go               project create / use / show / env / env write / doctor
  quickstart.go             quickstart create / env write / list
  init.go                   init — one-step: project + quickstart + env
  doctor.go                 project doctor — readiness checks, workspace mode
  install_doctor.go         Top-level agora doctor — install self-test (PATH, network, auth, MCP host)
  env_help.go               agora env-help — authoritative env-var catalog
  skills.go                 agora skills — curated workflow recipes (in-binary catalog)
  telemetry.go              telemetryClient interface + noop sink + Sentry placeholder (wire-up scheduled for next release)
  local_project.go          .agora/project.json read/write; repo-local project binding
  runtime_support.go        Template/runtime detection (nextjs, python, go), CI auto-detect, banner rules
  app_test.go               Unit tests for app init and config
  integration_test.go       Integration tests: build binary, shell out, assert JSON
docs/
  automation.md             Stable JSON output contract — machine-consumption source of truth
  install.md                Direct installer, platform, CI, and security guidance
  _config.yml               Jekyll / GitHub Pages configuration (human docs site)
  _layouts/, assets/        Theme assets for Pages
scripts/
  preview-pages-site.sh      Local Jekyll build + URL injection (`make docs-preview`)
  prepare-pages-site.py      Pages artifact prep (Markdown /md mirror, token expansion)
.github/workflows/
  ci.yml                    Push/PR matrix: Ubuntu, macOS, Windows
  release.yml               Tag-driven cross-platform release
  pages.yml                 Publish docs to GitHub Pages
  apt-repo.yml              Signed apt repository publishing

Read the full file on GitHub · 274 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. yesterday First seen · 274 lines · 3,447 tokens per session scan A 68730bfa2265

Subscribe to this mod's changes

cli AGENTS.md is an instructions file published in the GitHub repository AgoraIO/cli (5 stars, last pushed 7d ago), licensed MIT. It adds 3,447 tokens to every session, about $0.0172 per session on Opus 5. A static security scan graded it A with 2 findings (makes network calls, runs shell commands). 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

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

buildNext

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

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

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

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

langchain 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,345 tokens