chabeau AGENTS.md

Repository instructions for Chabeau, an open-source Rust chatbot that runs in a terminal and connects to remote services. Rust is a programming language focused on safety and performance.

In plain words
What is it for?
Guiding Chabeau development, including tests, formatting, static analysis, documentation updates, and review of usability, security, and accessibility.
Why use it?
They give coding agents the project's conventions, required checks, documentation rules, and boundaries for making changes.

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

Made for: Codex, OpenCode.

Per session 506 This file is loaded in full into every session.
When invoked 506 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.00506 $0.00506
Opus 5 $0.00253 $0.00253
Sonnet 5 $0.00101 $0.00101
Haiku 4.5 $0.00051 $0.00051

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

Security

Grade A, and why

chabeau 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 · 28 lines

How it starts

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

This repository contains Chabeau, an open source (CC-0) chatbot TUI for remote API-based access.

General guidelines

  • Follow best practices for Rust development and build/test/release processes.
  • Ensure new functionality does not introduce usability, security or accessibility regressions.
  • Add unit tests opportunistically.
  • Update docs as needed after you've completed the main objective:
    • Put user-facing behavior, usage guidance, and repository file-tree updates in README.md.
    • Put architecture notes, internal module responsibilities, and design rationale in ARCHITECTURE.md.
  • Always run cargo test, cargo check, cargo fmt and cargo clippy after you've completed the main objective.
  • Feel free to suggest changes to WISHLIST.md after all these steps have been completed. Thanks for making Chabeau better!
  • Do not add bugfix notes to the README. Keep README focused on user-facing features and behavior; document fixes in commit messages.

Additional style note for agents

  • Do not leave breadcrumb comments about past changes (e.g., "removed", "replaced", or historical notes in code). Keep comments focused on current behavior and intent only.

Commit summaries

  • When asked to draft a commit message, use a conventional commit format. The first line should be 50 characters wide max; subsequent lines 72 characters wide max. Keep it under 5 bullet points. Only summarize uncommitted (staged or working area) changes, not prior versions of those changes (e.g., if you refactored a function, and then refactored it again, only summarize its final state)
  • When constructing commit messages via CLI flags, prefer a single -m body with newline-separated bullets (or a heredoc) rather than multiple -m flags, to avoid extra blank lines between bullets.
  • When in interactive mode, present commit summaries to the user in a way that is easy to copy and paste with any formatting (e.g., markdown) intact.
  • Do not mention passing tests.

Performance validations

  • When you implement performance-sensitive features (rendering, scrolling, parsing, streaming), validate with Criterion benchmarks in addition to unit tests.
  • See benches/README.md for a quick scaffold on adding benches locally (and how to export internal modules temporarily via src/lib.rs).
  • Keep unit-test perf checks green (cargo test). Use benches to quantify improvements and regressions (cargo bench).

Read the full file on GitHub · 28 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 · 28 lines · 506 tokens per session scan A 140deebd0c28

Subscribe to this mod's changes

chabeau AGENTS.md is an instructions file published in the GitHub repository permacommons/chabeau (40 stars, last pushed 1mo ago), licensed CC0-1.0. It adds 506 tokens to every session, about $0.0025 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.