tbls-doc

Generate database schema documentation and ER diagrams from live databases using tbls.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/RyoMa99/dotfiles --skill tbls-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tbls-doc
Source: https://github.com/RyoMa99/dotfiles/tree/main/dot_claude/skills/tbls-doc
Command: npx skills add https://github.com/RyoMa99/dotfiles --skill tbls-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

tbls-doc enables teams to generate database schema documentation and ER diagrams directly from a live database using tbls, saving time on manual documentation and review.

Core Features & Use Cases

  • Generate comprehensive schema docs for tables, columns, and relationships.
  • Produce ER diagrams and table definitions to support architecture discussions.
  • Use cases include onboarding new databases, audits, and sharing up-to-date docs with teammates.

Quick Start

Generate the documentation by running tbls doc with your DSN and an output directory to create the schema docs.

Frequently Asked Questions about tbls-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate database schema documentation from a live database?

You generate database schema documentation by running tbls doc with your DSN and an output directory, which creates comprehensive schema docs for tables, columns, and relationships in a docs/schema directory.

Can I create ER diagrams for PostgreSQL and MySQL databases automatically?

Yes, you can automatically create ER diagrams for PostgreSQL, MySQL, and SQLite by connecting tbls to your live database using a DSN or .tbls.yml configuration file.

What is the best way to keep DB schema docs up to date for architecture reviews?

The best way to keep DB schema docs up to date is generating them directly from a live database using tbls, which ensures your documentation accurately reflects current table definitions and relationships for schema reviews.

Do I need a .tbls.yml configuration file to document my database schema?

You do not need a .tbls.yml configuration file to document your database schema, as tbls supports direct DSN connections as an alternative configuration method for generating schema documentation and ER diagrams.

Can I run lint and diff workflows after generating schema documentation?

Yes, you can run lint and diff workflows after generating schema documentation, extending the core tbls doc output to support database audits and detect schema changes over time.

Why generate ER diagrams directly from a live database instead of manually?

Generating ER diagrams directly from a live database saves time on manual documentation and ensures accuracy, producing up-to-date table definitions and relationship visualizations for onboarding and architecture discussions.