portolan-cli AGENTS.md

portolan-cli AGENTS.md is an instructions file for Codex, OpenCode from portolan-sdi/portolan-cli. It costs 4,102 tokens per session, scanned A, original, Apache-2.0.

Project instructions for the Portolan CLI, a command-line tool whose behaviour is defined by the Portolan specification. They cover repository rules, documentation, licensing, pull requests, issues, and verification.

In plain words
What is it for?
Use them when changing the CLI, writing documentation, preparing pull requests, handling issues, or checking commands against the shipped tool and project rules.
Why use it?
They help coding agents avoid documenting commands that do not exist, treating the CLI as the specification, bypassing checks, or using the wrong licence.

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

README.md
[![agentmods](https://agentmods.dev/badge/instructions/portolan-sdi/portolan-cli/agents-md.svg)](https://agentmods.dev/instructions/portolan-sdi/portolan-cli/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/portolan-sdi/portolan-cli/agents-md"><img src="https://agentmods.dev/badge/instructions/portolan-sdi/portolan-cli/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 4,102 This file is loaded in full into every session.
When invoked 4,102 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.04102 $0.04102
Opus 5 $0.02051 $0.02051
Sonnet 5 $0.00820 $0.00820
Haiku 4.5 $0.00410 $0.00410

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

Security

Grade A, and why

portolan-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 today.

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 · 259 lines

How it starts

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

Portolan Agent Norms

These rules apply to AI agents working in any portolan-sdi repo. Every downstream repo carries this text verbatim as a synced block at the top of its own AGENTS.md. Repo-specific instructions live below the block and override the canonical rules in that repo only.

Claude Code does not read AGENTS.md. Each repo carries a one-line CLAUDE.md that imports it instead. Put repo-specific instructions in AGENTS.md, never in CLAUDE.md, which the sync overwrites.

Ground Rules

The portolan-spec repo is ground truth for the Portolan standard. The CLI, validator, registry, and every other tool implement the spec. They are downstream of it. Never describe the CLI as the source of truth. Propose spec changes in portolan-spec.

Before documenting any command, flag, or API, verify it exists in the shipped tool. A fabricated example persists beyond the session that wrote it.

Every repo uses Apache-2.0 except portolan-browser and portolan-nl-demo, which are ISC forks. See norms/repos.md for the record. Never introduce code under another license without a human decision recorded there.

Never bypass pre-commit hooks or CI gates. Green means green.

Write commits in conventional form. Squash-merge makes the pull request title become the commit message.

Pull Requests and Issues

Write every issue and pull request in two layers. The human layer comes first: what is wrong or missing, why it matters, and what should happen instead. Someone who did not follow your investigation should understand it in about a minute. The agent layer comes after: evidence, implementation detail, constraints, edge cases, and verification.

There is no word limit. A 700-word issue is good when its first 150 words make the outcome obvious. A 150-word issue is bad when it compresses the meaning into prose the reader has to unpack. Optimize for fast comprehension, not for short tickets.

Read the full file on GitHub · 259 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. today Changed · +3 lines · +200 tokens per session 675fdf1f2b85
  2. 4d ago First seen · 256 lines · 3,902 tokens per session scan A fb89e1277ab8

Subscribe to this mod's changes

portolan-cli AGENTS.md is an instructions file published in the GitHub repository portolan-sdi/portolan-cli (30 stars, last pushed yesterday), licensed Apache-2.0. It adds 4,102 tokens to every session, about $0.0205 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

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 · 6,785 tokens

spec-kit AGENTS.md

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

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

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

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