What is octos CLAUDE.md?

A contributor guide for Octos, a Rust project with an agent loop, tools, and a command-line interface. It documents workspace tests, linting, formatting, installation, and optional features for integrations and audio output.

Use it when modifying Octos agents, tools, command-line features, messaging integrations, or podcast audio generation, and when running the project's checks.

It gives an agent the commands and project areas needed to make changes safely. It also clarifies which optional features are needed for particular checks.

How octos-org/octos configures Claude Code

About the project

Octos is a self-hosted AI assistant that runs on a user's computer and can connect to different AI providers, execute code, browse the web, remember information, schedule jobs, and create documents through browser, terminal, and messaging interfaces. The catalogue entries extend or configure this assistant's workflows.

octos-org/octos · 766 stars · on GitHub

Reuse

Borrowing it

Nothing to install: this file belongs to octos-org/octos. 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/octos-org/octos/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/octos-org/octos

Made for: Claude Code.

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/octos-org/octos/claude-md/github.svg)](https://agentmods.dev/instructions/octos-org/octos/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/octos-org/octos/claude-md"><img src="https://agentmods.dev/badge/instructions/octos-org/octos/claude-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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/octos-org/octos/claude-md"><img src="https://agentmods.dev/badge/instructions/octos-org/octos/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 3,157 This file is loaded in full into every session.

When invoked 3,157 The same file — it is already loaded in full.

Security scan C 1 finding. 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.

Model	Per session	Once invoked
Fable 5.1	$0.03157	$0.03157
Opus 5.5	$0.01263	$0.01263
Sonnet 5.5	$0.00631	$0.00631
Haiku 4.5	$0.00316	$0.00316

Measured today against content hash a8eff18e1645, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade C, and why

octos CLAUDE.md scanned grade C with 1 finding 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.

Recursive force deletehighDestructive command

rm -rf with a variable or a broad path is one typo away from removing the wrong tree.

- `ShellTool` has `SafePolicy` that denies dangerous commands (rm -rf /, dd, mkfs, fork bomb). Whitespace-normalized before matching. Timeout clamped to [1, 600]s.

CLAUDE.md · 163 lines

How it starts

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

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Build & Test Commands

cargo build --workspace          # Build all crates
cargo test --workspace           # Run all tests
cargo test -p octos-agent         # Test single crate
cargo test -p octos-agent test_name  # Run single test
cargo clippy --workspace         # Lint
cargo fmt --all                  # Format
cargo fmt --all -- --check       # Check formatting
cargo install --path crates/octos-cli \
    --features "api,telegram,discord,whatsapp,feishu,twilio,wecom,wecom-bot,audio_mp3"
                                          # Install CLI locally with the
                                          # canonical feature default
                                          # (matches scripts/milestone-ci.sh).
                                          # Default features include
                                          # `embed-llama` (the bundled
                                          # llama.cpp embedder): building
                                          # needs cmake + a C++ toolchain;
                                          # add `embed-llama-metal` on Apple
                                          # Silicon, or use
                                          # `--no-default-features --features api`
                                          # to skip it.
                                          # `api` is required for `octos serve`.
                                          # `audio_mp3` is required for the
                                          # `podcast_generate` workspace
                                          # contract to validate mp3 output
                                          # (see #1025).

Architecture

octos is a Rust-native, API-first Agentic OS — multi-tenant AI agent platform. 8-crate workspace + bundled skills, layered:

octos-cli  (CLI: clap commands, config loading, config watcher)
    |
octos-agent  (Agent loop, tool system, sandbox, MCP, compaction, plugins)
    |          \
octos-memory   octos-llm  (hybrid search + memory store | LLM providers)
    \           /
    octos-core  (Task, Message, Error types, truncate_utf8 - no internal deps)

Read the full file on GitHub · 163 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.

today Changed · -1 lines · -74 tokens per session a8eff18e1645
1mo ago Changed · +49 tokens per session b861954039f4
1mo ago Changed · +8 lines · +77 tokens per session 4cb8f8ecb830
2mo ago Changed · +37 tokens per session 7a95e69548a1
2mo ago Changed · +166 tokens per session 1a47fbaaf8dd
2mo ago First seen · 156 lines · 2,902 tokens per session scan C 9c3dca5a47aa

Subscribe to this mod's changes

octos CLAUDE.md is an instructions file published in the GitHub repository octos-org/octos (766 stars, last pushed today), licensed Apache-2.0. It adds 3,157 tokens to every session, about $0.0126 per session on Opus 5.5. A static security scan graded it C with 1 finding (recursive force delete). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

octos CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
octos CLAUDE.mdoctos-org/octos	Instructions file	766	today	Apache-2.0	C	3,157	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

octos: Instructions file for Claude Code