AGENTS.md · diff

git:20260724.27de5ae to git:20260724.3f1703c

19 added, 22 removed. Audit A to A.

# VillageSQL Project Context
- VillageSQL is a MySQL tracking fork with the VillageSQL Extension Framework (VEF) —
- a system for building custom SQL functions and types without modifying server code.
+ VillageSQL is a drop-in replacement for MySQL with extensions. The
+ VillageSQL Extension Framework (VEF) is a system for building custom SQL
+ functions and types without modifying server code.
Extensions are packaged as `.veb` files and installed at runtime.
- Key repos (cloned locally — check `AGENTS.local.md` for machine-specific paths):
- - `villagesql-server/` — core MySQL fork with VEF
- - `vsql-ai/`, `vsql-crypto/`, `vsql-uuid/`, `vsql-network-address/`, `vsql-http/`, `vsql-cube/` — official extensions
- - `villagesql-docs/` — Mintlify documentation (villagesql.com/docs)
- - `villagesql-website/` — Eleventy marketing site (villagesql.com)
-
- Server default socket: `/tmp/mysql.sock`, port 3306. Verify the actual socket
- from `pgrep -a mysqld` output before connecting. Check `AGENTS.local.md` for
- machine-specific overrides.
-
- ## Commit Standards
+ Key public repos:
+ - [villagesql-server](https://github.com/villagesql/villagesql-server) — the
+ core server with VEF; releases ship prebuilt binaries and the extension SDK
+ - [vsql-extension-template](https://github.com/villagesql/vsql-extension-template)
+ — the template every new C++ extension starts from
+ - [vsql-rust-sdk](https://github.com/villagesql/vsql-rust-sdk) — Rust SDK and
+ the `cargo-vsql` CLI
+ - Documentation: <https://villagesql.com/docs>
- - Summary line ≤41 characters, imperative mood, no period
- - Body lines ≤72 characters, explain WHY not WHAT
- - End with your agent's `AI=<TOOL>` and `Co-Authored-By:` attribution line
- - Run `villint.sh` before committing server code
- - Never push directly to `main`; never create PRs (stop at push)
+ Server connection: if `~/.villagesql/credentials.txt` exists (written by the
+ server installer), read paths, socket, and credentials from it. Otherwise the
+ default socket is `/tmp/mysql.sock`, port 3306 — verify the actual socket from
+ `pgrep -a mysqld` output before connecting. `AGENTS.local.md` (in `~/` or the
+ working directory) may contain machine-specific overrides.
## Key Rules
- All behavioral claims about the server require a live query to verify
- - Every claim in a blog post or doc must trace to a merged PR, live query result,
- or explicit engineer statement
- - Before finishing any task, check whether other repos reference the same term,
- path, or API
+ - Commit messages: summary line ≤50 characters, imperative mood, no period;
+ body lines ≤72 characters explaining WHY, not WHAT; end agent-authored
+ commits with your agent's `AI=<TOOL>` and `Co-Authored-By:` attribution
- Use `git -C /path <subcommand>` — never `cd /path && git`