tbls

Generate Markdown database schema documentation from live PostgreSQL connections.

Updated Jul 2, 2024
One-click install
npx skills add https://github.com/jyasuu/cheat-sheet --skill tbls
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tbls
Source: https://github.com/jyasuu/cheat-sheet/tree/main/skills/tbls
Command: npx skills add https://github.com/jyasuu/cheat-sheet --skill tbls

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

tbls automates the creation of database schema documentation from live databases, reducing manual effort and keeping docs in sync with changes.

Core Features & Use Cases

  • Generate up-to-date documentation for PostgreSQL and other databases
  • Output Markdown-friendly schema views suitable for onboarding, audits, and dashboards
  • Use Case: Generate a centralized docs page for an entire project’s database schema

Quick Start

Run tbls doc postgres://username:password@host:5432/dbname?sslmode=disable to generate documentation for your current database schema.

Frequently Asked Questions about tbls

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

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

To generate database schema documentation, run tbls doc with your live PostgreSQL connection string. It reads the live schema and outputs Markdown documentation files suitable for engineering teams, onboarding, and audits.

Can I automate Markdown documentation for my database schema?

Yes, you can automate database schema documentation with tbls. It reads your live database schema and outputs Markdown-friendly views, keeping your docs in sync with schema changes and reducing manual effort.

Does tbls support databases other than PostgreSQL?

Yes, tbls supports PostgreSQL and other databases. It requires a live connection to your supported database to read the schema and generate Markdown documentation for your project.

What's the best way to keep database schema docs in sync with schema changes?

The best way to keep database schema docs in sync is to automate generation with tbls. By reading the live database schema and outputting Markdown, it eliminates manual updates and ensures documentation matches your current database state.

Do I need a live database connection to generate schema documentation?

Yes, you need a live database connection to generate schema documentation. tbls reads the schema directly from your live PostgreSQL or other supported database to produce accurate Markdown documentation.

What format does tbls output for database schema documentation?

tbls outputs Markdown documentation for your database schema. This Markdown-friendly format is suitable for onboarding, audits, and dashboards, providing clear and centralized schema views for your engineering team.