sq AGENTS.md

Repository guidance for contributors and coding assistants working on sq, a command-line tool for querying databases and files such as CSV, JSON, and Excel.

In plain words
What is it for?
Use it when working on sq to understand repository conventions, choose relevant documentation, implement changes, and keep project docs accurate.
Why use it?
It points contributors to the right project documents, commands, architecture rules, and workflows before they make significant 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/neilotoole/sq/agents-md
Clone the repo
git clone --depth 1 https://github.com/neilotoole/sq

Made for: Codex, OpenCode.

Per session 3,837 This file is loaded in full into every session.
When invoked 3,837 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.03837 $0.03837
Opus 5 $0.01919 $0.01919
Sonnet 5 $0.00767 $0.00767
Haiku 4.5 $0.00384 $0.00384

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

Security

Grade A, and why

sq 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 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.

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

How it starts

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

AGENTS.md

Guidance for AI coding assistants (Claude Code, Copilot, Cursor, Codex, etc.) and human contributors working in this repo.

CLAUDE.md is the Claude Code entry point; it points here for all shared rules.

[!IMPORTANT] Before making a significant change, review docs/README.md and the contributor docs it links to (architecture, drivers, grammar, workflows, Sakila, releasing). Read the ones relevant to your task before you start, and if your change makes any of them inaccurate, update them in the same change.

About sq

sq is a command-line data wrangler providing jq-style access to structured data sources (SQL databases like Postgres, MySQL, SQLite, SQL Server, ClickHouse, Oracle, DuckDB; and document formats like CSV, JSON, Excel). User docs live at sq.io.

Key documents

Before making non-trivial changes, read the document most relevant to your task:

  • README.md: project overview and user-facing intro.
  • CONTRIBUTING.md: full contributor guide (tooling, Makefile usage, driver implementation patterns, test handles, CHANGELOG.md format).
  • docs/README.md: index of the contributor docs under docs/.
  • docs/ARCHITECTURE.md: Mermaid ERD of core types (Source, Driver, Grip, Registry, RecordWriter, etc.).
  • docs/DRIVERS.md: driver development guide (package structure, type mapping, the driver ship checklist).
  • docs/GRAMMAR.md: SLQ query language grammar guide (companion to grammar/SLQ.g4).
  • docs/WORKFLOW.md: development and CI workflows (local Makefile loop and the GitHub Actions pipelines).
  • docs/SAKILA.md: the Sakila test dataset (sakiladb images, embedded vs external sources, engine matrix, repo-wide usage).
  • sq.io: end-user documentation for commands and query syntax.

Read the full file on GitHub · 359 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 · 359 lines · 3,837 tokens per session scan A 513d05efdfea

Subscribe to this mod's changes

sq AGENTS.md is an instructions file published in the GitHub repository neilotoole/sq (2,556 stars, last pushed 2d ago), licensed MIT. It adds 3,837 tokens to every session, about $0.0192 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.