SQL Database Support for pREST
prest/prest
Guides classifying, gap-analyzing and scaffolding support for a new SQL database in pREST, from Postgres-compatible variants to entirely new dialects.
Execute runnable docs snippets and examples inside a disposable Docker Compose sandbox (runner container + local Supabase stack via supabase start).
Install Test The Docs
$ npx skills add supabase/supabase --skill test-the-docs -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install supabase/supabase test-the-docs --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/supabase/supabase.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/test-the-docs .claude/skills/test-the-docs && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "test-the-docs" agent skill from https://github.com/supabase/supabase/tree/master/.agents/skills/test-the-docs into .claude/skills/test-the-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "test-the-docs", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/supabase/supabase/tree/master/.agents/skills/test-the-docsType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add supabase/supabase --skill test-the-docs -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install supabase/supabase test-the-docs --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/supabase/supabase.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/test-the-docs .agents/skills/test-the-docs && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "test-the-docs" agent skill from https://github.com/supabase/supabase/tree/master/.agents/skills/test-the-docs into .agents/skills/test-the-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "test-the-docs", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add supabase/supabase --skill test-the-docs -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install supabase/supabase test-the-docs --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/supabase/supabase.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/test-the-docs .cursor/skills/test-the-docs && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "test-the-docs" agent skill from https://github.com/supabase/supabase/tree/master/.agents/skills/test-the-docs into .cursor/skills/test-the-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "test-the-docs", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/supabase/supabase.git --path .agents/skills/test-the-docs--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add supabase/supabase --skill test-the-docs -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install supabase/supabase test-the-docs --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/supabase/supabase.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/test-the-docs .gemini/skills/test-the-docs && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "test-the-docs" agent skill from https://github.com/supabase/supabase/tree/master/.agents/skills/test-the-docs into .gemini/skills/test-the-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "test-the-docs", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install supabase/supabase test-the-docsInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add supabase/supabase --skill test-the-docs -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/supabase/supabase.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/test-the-docs .github/skills/test-the-docs && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "test-the-docs" agent skill from https://github.com/supabase/supabase/tree/master/.agents/skills/test-the-docs into .github/skills/test-the-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "test-the-docs", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add supabase/supabase --skill test-the-docs -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install supabase/supabase test-the-docs --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/supabase/supabase.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/test-the-docs .opencode/skills/test-the-docs && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "test-the-docs" agent skill from https://github.com/supabase/supabase/tree/master/.agents/skills/test-the-docs into .opencode/skills/test-the-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "test-the-docs", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
test-the-docs- GitHub stars
- 111k
- Token cost
- ~1.3k tokens
- SKILL.md length
- 537 words
- Files
- 9
- Skills in repo
- 22
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
Execute runnable docs snippets and examples inside a disposable Docker Compose sandbox (runner container + local Supabase stack via supabase start).
- Works in 6 steps: Scope → Extract → Classify → …
- Tasks that involve Fact-checking and source verification
- SKILL.md covers When to invoke, Core rules, Phases and Related skills
- Runs Shell scripts from its folder; calls supabase, npm and docker
What it does
Test The Docs is an agent skill from supabase/supabase, published by the product's own GitHub organization. Execute runnable docs snippets and examples inside a disposable Docker Compose sandbox (runner container + local Supabase stack via supabase start). Use after Draft or during Self-review when asked to test the docs, fact-check CLI/SQL/code samples, or produce a verification report for a docs PR. Complements review-the-docs build and review checks; does not replace them.
Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. The skill folder holds 11 other files (for example `reference/sandbox-setup.md`, `reference/snippet-classes.md` and `reference/verification-report.md`).
It sits in Databases, covering Fact-checking and source verification, Containers and SQL. It works with Supabase, SQL and Docker. The repository describes itself as: The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications. The licence is Apache-2.0.
When your agent uses it
- Tasks that involve Fact-checking and source verification
- Tasks that involve Containers
- Tasks that involve SQL
Example prompts
- “/test-the-docs”
Requirements
- Node.js
- A Bash shell
- Docker
Workflow steps
6 steps, taken from the step headings in SKILL.md.
What it can do on your machine
Read from SKILL.md and the folder at commit 26c838a. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
Ships script files (Shell), which the agent can run.
Shell commands in SKILL.md call:
supabasenpmdockergit
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md. Its commands use supabase, npm, docker and git, which can reach the network depending on how they are called.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Test The Docs loads about 1.3k tokens when it runs. Until then it costs about 97 tokens; SKILL.md has 537 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from supabase/supabase at commit 26c838a, republished under its Apache-2.0 licence (© supabase). 537 words, ~1,300 tokens.
Download SKILL.mdSave it as
.claude/skills/test-the-docs/SKILL.md (or your agent's skills folder). This skill also uses 8 other files; get the full folder from GitHub.- name
- test-the-docs
- description
- Execute runnable docs snippets and examples inside a disposable Docker Compose sandbox (runner container + local Supabase stack via `supabase start`). Use after Draft or during Self-review when asked to test the docs, fact-check CLI/SQL/code samples, or produce a verification report for a docs PR. Complements review-the-docs build and review checks; does not replace them.
Test the docs
Runs procedural docs content inside disposable containers, not on the host shell and not against production. Produces a verification report for the PR body / self-review note.
For markdown rebuilds, example-app triage, and PR review, use review-the-docs. For Frame/Shape and cross-repo product lookup, use pm-the-docs.
When to invoke
- After Draft, before or during Self-review (checklist Stage 4).
- Standalone: "test the docs", "fact-check these snippets", "run the examples".
- Content or tutorial PRs that add or change procedural fenced blocks.
Not for: generated reference pages, docs-app architecture questions, or hosted/production projects.
Core rules
- Never run against production. Local stack or temp dir only.
- Never run MDX fences on the host shell. Use the Compose sandbox — see reference/sandbox-setup.md and
sandbox/run.sh. - Proportional: Tier A (one end-to-end path) is required; Tier B spot-checks new/changed procedural blocks, not every fence on every page.
- Product bugs found while testing get linked or filed separately; fix docs only when the docs are wrong.
Phases
1. Scope
From explicit MDX paths, or:
git diff --name-only master...HEAD -- 'apps/docs/content/**'Skip generated reference output under features/docs/generated/.
2. Extract
List runnable artifacts from changed MDX:
- Fenced blocks:
bash,sh,sql,javascript,typescript,tsx,jsx $CodeSamplepaths → treat asexample-app(build underexamples/)- Skip:
mermaid, incomplete illustrative fragments, partial-only includes
3. Classify
Assign each artifact a class per reference/snippet-classes.md:
| Class | Action |
|---|---|
runnable-local | Run in temp stack / temp dir |
runnable-with-setup | Run after documented setup (migrations, seed) |
example-app | npm install && npm run build in examples/… |
illustrative-only | No run required |
deferred | Record reason; do not silently skip |
Show full SKILL.md (286 more words)Show less
4. Sandbox setup
Follow reference/sandbox-setup.md and drive lifecycle with sandbox/run.sh:
- Refuse if the host is running as root.
- Require
docker+docker info+docker composeon the host for any in-container run. - Gate profiles per artifact class:
runnable-local/runnable-with-setupthat need DB/API:./sandbox/run.sh up-stack(DinD + runner →supabase init/supabase startin/work).- CLI-only blocks with no DB: still use a runner profile so fences stay off-host; skip
supabase startwhen unused. example-app:TTD_EXAMPLE_DIR=<repo>/examples/<app> ./sandbox/run.sh up-examples(Node in runner; no DinD). Do not defer solely because the host lacks a global Supabase CLI.
- Always
./sandbox/run.sh downwhen finished (cleanup trap on the host session). - Capture connection URLs only inside the runner; never paste credential fields into notes or logs.
If a required prerequisite for that artifact is unavailable, mark that artifact deferred with the specific reason — never silent skip, and do not defer unrelated classes.
5. Execute
- Tier A: one copy-pasteable end-to-end path from the page.
- Tier B: each new/changed block classified
runnable-*orexample-app(build and record the result). - Run every fence via
./sandbox/run.sh execorexec-timeout(never a bare host shell). - Bound every artifact: default 60s for shell / SQL / JS / TypeScript /
tsx/jsx; allow longer forexample-appinstall/build (e.g. 5m). On timeout, kill the process group inside the runner, then recordfailordeferredwith reason. curl/wgetonly to filtered stack URLs (or page-documented local endpoints).npm/npx/nodeonly for mountedexample-appbuilds.- Capture exit code, stdout/stderr (redact secrets), and observed vs expected behavior.
6. Report
Write a verification report per reference/verification-report.md for the PR body / self-review note.
Related skills
write-the-docs— Draft; hands off here before PRreview-the-docs— build/classify; consumes verification reportpm-the-docs— Frame/Shape; universe for cross-repo product lookup
© supabase, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 8 other files in .agents/skills/test-the-docs of supabase/supabase.
- SKILL.md
- reference/sandbox-setup.md
- reference/snippet-classes.md
- reference/verification-report.md
- sandbox/.empty/.keep
- sandbox/.gitignore
- sandbox/Dockerfile
- sandbox/compose.yaml
- sandbox/run.sh
Open the folder on GitHubat commit 26c838a
Compare with similar skills
Test The Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Test The Docs this skillsupabase/supabase | 111k | — | ~1.3k | Automated safety check: Pass | Apache-2.0 | |
| SQL Database Support for pRESTprest/prest | 4.6k | — | ~1.6k | Automated safety check: Pass | MIT | |
| StarRocks SQL Doc Auto-FixStarRocks/starrocks | 12k | — | ~7.6k | Automated safety check: Notes | Apache-2.0 | |
| Replica ArchitectJakeschincariol/replica-skill | 908 | — | ~1.1k | Automated safety check: Pass | MIT | |
| Srtd CLIt1mmen/srtd | 105 | — | ~360 | Automated safety check: Pass | MIT | |
| Expert DatabaseReJeCtAll/ExpertTeam-Codex | 113 | — | ~692 | Automated safety check: Pass | MIT |
Similar skills
StarRocks SQL Doc Auto-Fix
StarRocks/starrocks
Proposes verified fixes for failing SQL examples in StarRocks docs across three languages and several versions, then opens draft pull requests and never merges.
Replica Architect
Jakeschincariol/replica-skill
Plans the stack, database schema and API for an app clone, from the recon map replica-recon wrote.
Srtd CLI
t1mmen/srtd
This skill should be used when the user mentions "srtd", "sql templates", "migrations-templates", "live reload sql", "supabase functions", when working with files in supabase/migrations-templates/…
Expert Database
ReJeCtAll/ExpertTeam-Codex
数据库优化专家入口。用于 Codex CLI 的 $expert-database 调用. An agent skill from ReJeCtAll/ExpertTeam-Codex.
DB Migrate
alexeykrol/claude-code-starter
Миграция схемы базы данных: SQLite → PostgreSQL/Supabase. An agent skill from alexeykrol/claude-code-starter.
More from supabase/supabase
All 22 skills in this repo- Official
Vercel Composition Patterns
supabase/supabase
React composition patterns that scale. An agent skill from supabase/supabase.
- Official
Clickhouse Logs Queries
supabase/supabase
Write, review, and migrate Supabase logs queries against the ClickHouse-backed logs table (the logs.all.otel analytics endpoint).
- Official
Review The Docs
supabase/supabase
Review Supabase docs changes locally in your supabase/supabase checkout — either an open PR (triage, classify, verify) or your own branch before opening a PR (local self-review).
- Official
Vitest
supabase/supabase
Vitest API and config reference (Jest-compatible) — mocking with vi., spies, fake timers, coverage configuration, fixtures, snapshots, and test filtering.
- Official
Safe SQL Execution
supabase/supabase
A skill your agent uses whenever code will build, return, fetch, or execute SQL that runs against a user's real Postgres database — even when the request reads like an ordinary feature or bug fix…
- Official
Studio E2E Tests
supabase/supabase
Write and run Playwright E2E tests for Supabase Studio (e2e/studio).
Related
Questions about Test The Docs
What does Test The Docs do?
Execute runnable docs snippets and examples inside a disposable Docker Compose sandbox (runner container + local Supabase stack via supabase start). Test The Docs is an agent skill from supabase/supabase, published by the product's own GitHub organization. Execute runnable docs snippets and examples inside a disposable Docker Compose sandbox (runner container + local Supabase stack via supabase start).
When should I use Test The Docs?
Test The Docs fits situations like: tasks that involve Fact-checking and source verification; tasks that involve Containers; tasks that involve SQL.
How do I install Test The Docs in Claude Code?
Run `npx skills add supabase/supabase --skill test-the-docs -a claude-code`. Or copy the skill folder (.agents/skills/test-the-docs in supabase/supabase) into .claude/skills/test-the-docs in your project. Claude Code loads it when a task matches its description.
How do I install Test The Docs in Codex?
Run `npx skills add supabase/supabase --skill test-the-docs -a codex`. Or copy the skill folder (.agents/skills/test-the-docs in supabase/supabase) into .agents/skills/test-the-docs in your project. Codex loads it when a task matches its description.
Can I use Test The Docs in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add supabase/supabase --skill test-the-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/test-the-docs, .gemini/skills/test-the-docs, .github/skills/test-the-docs and .opencode/skills/test-the-docs in your project.
What does Test The Docs need to run?
Going by SKILL.md and its folder, Test The Docs needs a shell for the scripts in its folder and the command-line tools its instructions call (supabase, npm, docker and git). Our summary lists: Node.js; A Bash shell; Docker.
Does Test The Docs access the network?
SKILL.md contains no URLs. Its commands use npm, docker and git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.
Is Test The Docs safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Test The Docs use?
Test The Docs is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Test The Docs use?
About 1.3k tokens (SKILL.md is roughly 5.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Test The Docs?
Skills that share tags, products or a category with Test The Docs: SQL Database Support for pREST (prest/prest, 4.6k stars), StarRocks SQL Doc Auto-Fix (StarRocks/starrocks, 12k stars), Replica Architect (Jakeschincariol/replica-skill, 908 stars) and Srtd CLI (t1mmen/srtd, 105 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Test The Docs?
supabase (a GitHub organization, an official publisher) maintains it in supabase/supabase, which has 111,222 GitHub stars. The repository holds 22 skills in this directory. The repository was last updated on October 8, 2026.
Source: supabase/supabase on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.