Quickstart
Auto-detect local databases, configure rules, and generate agent context in one command.
schemap quickstart
The dangerous kind of wrong
Looks right. Is it or is it not?
AI can confidently generate a query that matches familiar naming patterns—but misses the relationships that are true in your database.
Plausible query, wrong relationship
SELECT orders.id, users.email
FROM orders
JOIN users
ON orders.customer_id = users.id;The query looks reasonable. Your schema has no
orders.customer_id.
Explicit relationship context
orders.account_id
↓
accounts.id
↓
users.account_idSchemap gives the agent the relationship map it was missing.
The missing context
Your AI doesn’t know what your tables mean.
Raw dumps describe structure, but bury the context an agent needs to make reliable database decisions.
01
Relationships are easy to miss
Foreign keys and join paths disappear inside a wall of DDL.
02
Names are not business context
acct_id may mean something completely different in your domain.
03
More tokens are not more clarity
Noise consumes the context window before the real problem begins.
A context layer for your database
From raw structure to useful context.
01Your databaseSchema metadata
→
02SchemapInspect · score
· compile
→
03AI-ready contextMaps · joins ·
rules
Claude Code · Cursor · Codex · Copilot · Custom agents
One command
Give your agent the database it actually has.
Schemap runs locally, extracts the relationships that matter, and writes context files your existing workflow can use.
Try it in your project ↗$ schemap context
→ Inspecting schema...
→ Mapping foreign-key relationships...
→ Compiling AI context...
✓ Context written to schemap_database_context.md
$ schemap benchmark
Measure raw vs compiled tokens on your schema.
Measure, don’t guess
Make room for the problem you’re solving.
Token savings vary by schema. The built-in benchmark reports your raw estimate, compiled context size, relationship coverage, readiness score, and compile latency.
↓Token footprintMeasured per database
◎AI readinessActionable schema score
↗Relationship clarityExplicit join paths
The workflow
Everything your agent needs to stop guessing.
Auto-Fix
Interactively accept inferred foreign key candidates and abbreviation mappings.
schemap fix --interactive
Explain & Join
Inspect table architecture and auto-solve shortest foreign key join paths with SQL snippets.
schemap explain / join
Agent Skills
Install agent-native guardrail skills for Claude Code, Cursor rules, and Codex.
schemap skills install
Context & Sync
Compile Markdown, JSON, MCP, or Mermaid ER diagrams. Sync on schema changes.
schemap context / sync
Diff & CI Gate
Track schema changes and fail CI builds on breaking data type removals.
schemap diff --fail-on-breaking
Built for developer workflows
Your schema stays in your workflow.
Extraction and compilation run locally by default. Schemap produces files you can inspect, commit, review, and inject into the tools you already use.
Supported databases
PostgreSQL · SQLite · MySQL · Turso/libSQL · Oracle
Optional enrichment--enrich can use the configured OpenAI API
to improve business descriptions.
License checks
Licensed CI/CD usage verifies a license online; local free
usage does not require an external AI service.
Start locally in 60 seconds
Add an AI database context layer.
Install the CLI, point it at your schema, and compile instant AI-ready context.
Free (Works immediately)
# 1. Install developer CLI globally
pipx install schemap-tool# 2. Verify installation
schemap --version# 3. Initialize & compile context
schemap initschemap context
Pro (Optional activation)
# Activate Pro key anytime for unlimited tables & CI/CD
schemap activate YOUR_LICENSE_KEY
Requirements: Python 3.10+
Already installed? Upgrade anytime:
pipx upgrade schemap-tool
2026 Founder Program
Start free. Upgrade when your workflow grows.
The full local CLI is available for free. Pro unlocks larger schemas, CI/CD automation, and production workflow support.
Free
$0
For local projects and evaluation.
- Up to 100 tables
- Full local CLI
- Inspect, score, context, diffs, benchmarks, and exports
- No account or API key required
Pro
$7.99/mo
Flexible monthly billing.
- Unlimited tables
- CI/CD execution
- Production schema workflows
- Priority support and founder benefits
Founder Lifetime
$79.99 once
One payment for lifetime Pro access.
- Everything in Pro
- Future Pro updates
- Founder feature access
- Available during 2026
Developer FAQ
A few practical answers.
How do I update Schemap to the latest version?
Run pipx upgrade schemap-tool (or uv tool upgrade schemap-tool / pip install --upgrade schemap-tool). You can verify your active CLI version anytime with schemap --version.
Does Schemap send my database data to an AI?
Not by default. Extraction and compilation run locally. Optional --enrich sends
compressed schema metadata to the configured OpenAI API. Licensed CI/CD usage also performs
an online license check.
Does Schemap replace my ORM?
No. Schemap creates context for agents and SQL workflows. Your ORM, migrations, and application remain the source of truth for runtime behavior.
Can I use it with Cursor, Claude Code, Codex, or Copilot?
Yes. Generate Markdown context, CLAUDE.md, AGENTS.md, JSON, MCP, or framework exports for the workflow your agent already reads.
Which databases are supported?
PostgreSQL, SQLite, MySQL, Turso/libSQL, and Oracle are supported by the current extractors.
Give your database a context layer
Your AI is only as good as the context you give it.
Make the relationships explicit before your agent starts writing SQL.