chdb: Instructions file for Codex

AGENTS.md

chdb AGENTS.md is an instructions file for Codex, OpenCode from chdb-io/chdb. It costs 257 tokens per session, scanned A, original, Apache-2.0.

Repository instructions for chDB, a data-processing system that uses table-like data and SQL. They describe lazy execution, where work is postponed until results are needed, plus testing and contribution rules.

In plain words
What is it for?
Use them when changing the DataStore layer to return lazy data objects, avoid forcing execution too early, preserve compatible pandas-style and SQL-like APIs, and follow the project’s build and test process.
Why use it?
They help preserve the project’s design by keeping data operations lazy and allowing the final engine to choose how computation runs.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md.

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

About the project

chDB is an in-process OLAP SQL engine powered by ClickHouse, allowing applications to query analytical data without running a separate database server. Python users and data practitioners use it to work with formats such as Parquet, CSV, JSON, Arrow, and ORC through SQL or a pandas-compatible API. Its catalogue add-ons provide agent instructions, rules, skills, and an agent for working with the project.

chdb-io/chdb · 2,921 stars · on GitHub · clickhouse.com

Reuse

Borrowing it

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

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 chdb AGENTS.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/chdb-io/chdb/agents-md"><img src="https://agentmods.dev/badge/instructions/chdb-io/chdb/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 257 This file is loaded in full into every session.
When invoked 257 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.00257 $0.00257
Opus 5.5 $0.00103 $0.00103
Sonnet 5.5 $0.00051 $0.00051
Haiku 4.5 $0.00026 $0.00026

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

Security

Grade A, and why

chdb 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 1mo 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 · 32 lines

What it actually says

AGENTS.md — chDB

This repository contains chDB's pandas-compatible DataStore API. The embedded ClickHouse engine and native bindings live in chdb-io/chdb-core.

See CONTRIBUTING.md for setup, commands, and contributor workflow.

Architecture

  • Keep DataFrame- and Series-producing operations lazy until their results are naturally required.
  • Do not call _execute() directly or add eager conversions to work around planner problems.
  • Keep one expression and planning model; select pandas or chDB execution at execution time.

Tests

  • Mirror DataStore operations in pandas and compare columns, values, and row order when the operation defines it.
  • Regression tests should reproduce the user's full operation chain. Run the property-based chain tests for dispatcher, planner, or SQL-builder changes.
  • Do not weaken assertions or use reset_index() to hide incorrect behavior.
  • Run the smallest relevant tests first, then the relevant full suite. Report only checks that were actually run.

Repository skills

Shared coding-agent skills live under .agents/skills.

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. 1mo ago Changed · -167 lines · -1,517 tokens per session 99ee15e9a43e
  2. 2mo ago First seen · 199 lines · 1,774 tokens per session scan A 161524ddccb9

Subscribe to this mod's changes

chdb AGENTS.md is an instructions file published in the GitHub repository chdb-io/chdb (2,921 stars, last pushed 16d ago), licensed Apache-2.0. It adds 257 tokens to every session, about $0.0010 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-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 · 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,731 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens