DbSketch

KO | EN

gitlite — search

#javascript #hacktoberfest #react #typescript #llm #go #android #rust #docker #macos #java #awesome #vue #ios

(★ 23)

Generate compact database schema diagrams and Markdown docs from live SQL Server, PostgreSQL, and MySQL databases — useful for docs, CI, and LLM context.

DbSketch 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# DbSketch

[![CI](https://github.com/DimonSmart/DbSketch/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/DimonSmart/DbSketch/actions/workflows/ci.yml)
[![Release](https://github.com/DimonSmart/DbSketch/actions/workflows/release.yml/badge.svg)](https://github.com/DimonSmart/DbSketch/actions/workflows/release.yml)
[![NuGet](https://img.shields.io/nuget/v/DimonSmart.DbSketch.svg)](https://www.nuget.org/packages/DimonSmart.DbSketch)

DbSketch turns a live database into version-controlled schema documentation.

It reads tables, columns, primary keys, and foreign keys directly from SQL Server, PostgreSQL, MySQL, or SQLite. It can include native comments where providers support them, apply YAML comment overrides, and generate diagram-as-code files you can commit, review, render, reuse as LLM context, and refresh from CI.

DbSketch is useful when both humans and AI coding assistants need a compact, reviewable schema snapshot. Instead of asking an agent to inspect the database with ad-hoc commands or parse creation scripts and migrations, you can give it generated schema documentation that already contains the relevant tables, columns, keys, relationships, and comments.

## What it produces

DbSketch is a CLI documentation generator, not a visual database designer. Its primary output is text-based, Markdown-friendly documentation:

- `.dot`: Graphviz DOT, best for precise technical diagrams and column-to-column foreign key edges.
- `.mmd`: Mermaid ER, convenient for Markdown renderers that support Mermaid diagrams.
- `.md`: Markdown documentation that wraps DOT or Mermaid in a fenced code block.

These files can often be used directly in repositories, wikis, issue trackers, documentation sites, and other tools that understand diagram-as-code or Markdown-like formats.

## What it looks like

Compact schema diagram:

![Compact DbSketch generated Northwind database schema](https://raw.githubusercontent.com/DimonSmart/DbSketch/main/docs/assets/northwind-schema-compact.png)

Detailed schema diagram with comments and column metadata:

![Full DbSketch generated Northwind database schema](https://raw.githubusercontent.com/DimonSmart/DbSketch/main/docs/assets/northwind-schema-full.png)

## Why DbSketch?

- Reads live SQL Server, PostgreSQL, MySQL, and SQLite schemas
- Generates Graphviz DOT, Mermaid ER, or Markdown-wrapped output
- Supports multiple focused diagrams from one config
- Preserves precise column-to-column foreign key edges in DOT
- Can include native database comments where supported, and YAML comment overrides for providers such as SQLite
- Works locally, in CI, or as a repository documentation step
- Produces compact schema context for AI coding assistants

## AI-assisted setup

Want ChatGPT, Claude, Codex, or another coding assistant to add DbSketch to an existing repository? See [AI-assisted setup](https://github.com/DimonSmart/DbSketch/blob/main/docs/ai-setup.md) for copy-paste prompts and review guidance.

## Documentation

Start here:

- [Getting started](https://github.com/DimonSmart/DbSketch/blob/main/docs/getting-started.md)
- [AI-assisted setup](https://github.com/DimonSmart/DbSketch/blob/main/docs/ai-setup.md)

Reference:

- [Configuration](https://github.com/DimonSmart/DbSketch/blob/main/docs/configuration.md)
- [Full config example](https://github.com/DimonSmart/DbSketch/blob/main/docs/examples/full-config.md)
- [Renderers](https://github.com/DimonSmart/DbSketch/blob/main/docs/renderers.md)
- [Database comments](https://github.com/DimonSmart/DbSketch/blob/main/docs/comments.md)
- [CI and automation](https://github.com/DimonSmart/DbSketch/blob/main/docs/ci.md)

Examples and development:

- [Northwind example](https://github.com/DimonSmart/DbSketch/blob/main/docs/examples/northwind.md)
- [Development](https://github.com/DimonSmart/DbSketch/blob/main/docs/development.md)

## Contributing

Issues and pull requests are welcome, especially focused fixes, provider improvements, renderer improvements, and documentation updates.

DbSketch

DbSketch 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

DbSketch

DbSketch 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README