sq / cli
AGENTS.md2.6k starsChanged 12 days agoMITView on GitHub
Conventions specific to the cli package: cobra command construction, flags, shell completion, and output writers. Repo-wide rules in AGENTS.md still apply here. Every command that accepts arguments must offer shell completion via the cobra command's ValidArgsFunction. Completion is part of the command, not an optional extra: a new command, or a new positional argument on an existing one, is not done until its arguments tab-complete. Reuse the helpers in complete.go rather than hand-rolling completion: - Source handles: completeHandle(maxVals, includeActive), or…
We split this AGENTS.md into the rules it gives an agent
2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 9
Every command that accepts arguments must offer shell completion via the cobra command's ValidArgsFunction.
- Very specific: line 33
Add a completion test with the command, using the testComplete helper (see the existing *_Completion tests).
≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
AGENTS.md (cli/)
Conventions specific to the cli package: cobra command construction, flags,
shell completion, and output writers. Repo-wide rules in
AGENTS.md still apply here.
Shell completion
Every command that accepts arguments must offer shell completion via the cobra
command's ValidArgsFunction. Completion is part of the command, not an
optional extra: a new command, or a new positional argument on an existing one,
is not done until its arguments tab-complete.
Reuse the helpers in complete.go rather than hand-rolling
completion:
- Source handles:
completeHandle(maxVals, includeActive), orcompleteHandleOrGroupwhere a group is also valid. - Keyring entry paths:
completeKeyringPath. - Other values (booleans, catalogs, schemas, drivers): the matching
complete*helper.
Cap positional completion at the number of args the command takes (maxVals),
and set includeActive by whether the @active shortcut is a sensible target.
Commands with no positional arguments need no ValidArgsFunction. Arguments
whose values are inherently free-form are likewise exempt, since there is
nothing to enumerate: a new name the user invents, a literal value to store, an
arbitrary SQL or SLQ query. For example, config keyring create PATH takes no
completion for PATH, because it must be a new entry that does not yet exist;
suggesting existing paths would only offer names the command rejects.
Add a completion test with the command, using the testComplete helper (see
the existing *_Completion tests).
Trending
Less talk lately.about the whole repository
Who's talking about neilotoole/sq
- avelino/awesome-go“few packages that can be added”GitHub · Dec 25, 2024 · 5 reactions
- A Hacker News story“sq: Swiss-army knife for data”Hacker News · Mar 5, 2021 · 5 points
- sudosubin/agents.nix“claude-code-plugins.github.neilotoole.sq: init at 0.55.0”GitHub · Oct 28, 2026
- sudosubin/agents.nix“claude-code-marketplaces.github.neilotoole.sq: init at 0.55.0”GitHub · Oct 28, 2026
- NixOS/nixpkgs“sq: 0.54.1 -> 0.55.0”GitHub · Sep 10, 2026
The biggest 5 of 44 mentions linking to the repository that our crawl found. Each line is their own headline.
See all 44
Talked about on GitHub and Hacker News (44 times).
On GitHub · 43
- Dec 25, 2024few packages that can be added — avelino/awesome-go5 reactions
- Oct 28, 2026claude-code-plugins.github.neilotoole.sq: init at 0.55.0 — sudosubin/agents.nix0 reactions
- Oct 28, 2026claude-code-marketplaces.github.neilotoole.sq: init at 0.55.0 — sudosubin/agents.nix0 reactions
- Sep 10, 2026sq: 0.54.1 -> 0.55.0 — NixOS/nixpkgs0 reactions · 3 comments
- Sep 10, 2026sq 0.55.0 — Homebrew/homebrew-core0 reactions · 1 comment
38 more on GitHub
- Aug 1, 2026sq: 0.50.0 -> 0.54.1, adopt package — NixOS/nixpkgs0 reactions · 1 comment
- Jun 30, 2026Add XLSX spreadsheet compare/diff support — ONLYOFFICE/DocumentServer0 reactions · 2 comments
- Jun 19, 2026sq 0.54.0 — Homebrew/homebrew-core0 reactions · 1 comment
- Jun 7, 2026Recipe: Lima/Colima profile for cluster discovery from macOS — sakiladb/rqlite0 reactions · 1 comment
- Jun 7, 2026Docs: document the host-side cluster-discovery footgun (single-node and cluster-compose) — sakiladb/rqlite0 reactions · 1 comment
- Jun 7, 2026Schema divergence from canonical SQLite Sakila: NUMERIC affinity, missing AUTOINCREMENT, missing DEFAULT — sakiladb/rqlite0 reactions
- May 26, 2026sq 0.53.0 — Homebrew/homebrew-core0 reactions · 1 comment
- May 18, 2026[Request]: sq — ScoopInstaller/Main0 reactions
- May 16, 2026sq 0.52.0 — Homebrew/homebrew-core0 reactions · 1 comment
- May 1, 2026sq: 0.50.0 -> 0.54.1 — NixOS/nixpkgs0 reactions · 5 comments
- Apr 24, 2026sq 0.50.2 — Homebrew/homebrew-core0 reactions · 1 comment
- Mar 28, 2026sq: 0.48.12 -> 0.50.0 — NixOS/nixpkgs0 reactions
- Feb 15, 2026sq 0.49.0 — Homebrew/homebrew-core0 reactions · 1 comment
- Jan 30, 2026sq 0.48.12 — Homebrew/homebrew-core0 reactions · 1 comment
- Jan 19, 2026sq: 0.48.10 -> 0.48.12 — NixOS/nixpkgs0 reactions · 1 comment
- Jan 18, 2026sq 0.48.11 — Homebrew/homebrew-core0 reactions · 1 comment
- Jan 3, 2026sq: 0.48.5 -> 0.48.10 — NixOS/nixpkgs0 reactions · 1 comment
- Dec 28, 2025Failure to detect XLSX — h2non/filetype0 reactions
- Nov 21, 2025[WIP] Investigate replacing jq executable calls with sq library — github/gh-aw0 reactions
- Mar 9, 2025Add nixos as a supported package manager — neilotoole/sq-web0 reactions · 1 comment
- Jan 20, 2025sq: 0.48.4 -> 0.48.5 — NixOS/nixpkgs0 reactions
- Dec 27, 2024add package neilotoole/sq — avelino/awesome-go0 reactions · 1 comment
- Nov 25, 2024sq: 0.48.3 -> 0.48.4 — NixOS/nixpkgs0 reactions
- Oct 8, 2024feat: 🎸 "sq" のインストールスクリプトを追加した — nikukyugamer/dotfiles0 reactions
- Oct 8, 2024Add github.com/neilotoole/sq — aquaproj/aqua-registry0 reactions · 2 comments
- Jan 30, 2024sq: 0.46.1 -> 0.47.4 — NixOS/nixpkgs0 reactions · 3 comments
- Dec 8, 2023sq: 0.42.1 -> 0.46.1 — NixOS/nixpkgs0 reactions
- Sep 26, 2023sq: 0.42.0 -> 0.42.1 — NixOS/nixpkgs0 reactions
- Aug 26, 2023sq: 0.40.0 -> 0.42.0 — NixOS/nixpkgs0 reactions
- May 31, 2023sq: 0.35.0 -> 0.36.2 — NixOS/nixpkgs0 reactions
- May 8, 2023sq: 0.33.0 -> 0.35.0 — NixOS/nixpkgs0 reactions · 1 comment
- Mar 14, 2023sq: 0.24.0 -> 0.24.1 — NixOS/nixpkgs0 reactions
- Dec 31, 2022sq: 0.18.2 -> 0.20.0 — NixOS/nixpkgs0 reactions
- Dec 26, 2022sq: 0.16.0 -> 0.18.2 — NixOS/nixpkgs0 reactions
- Dec 20, 2022sq: 0.15.11 -> 0.16.0 — NixOS/nixpkgs0 reactions
- Nov 10, 2022sq: 0.15.6 -> 0.15.11 — NixOS/nixpkgs0 reactions
- Aug 10, 2022sq: 0.15.4 -> 0.15.6 — NixOS/nixpkgs0 reactions
- Sep 16, 2021Initial code — neilotoole/jsoncolor0 reactions
On Hacker News · 1
- Mar 5, 2021sq: Swiss-army knife for data5 points
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository8 other files it gives its agents.
- AGENTS.mdAGENTS.md
- site/AGENTS.mdAGENTS.md
- code-reviewSkill
- sq-actions-dependabotSkill
- sq-ci-triageSkill
- sq-gomod-dependabotSkill
- sq-site-dependabotSkill
- sqSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

