k1LoW/tbls

어떤 프로젝트인가요?

핵심 기능

• 01데이터베이스 스키마에서 GitHub에 적합한 Markdown 문서를 생성합니다.
• 02SVG, PNG, JPG 또는 Mermaid 형식으로 ER 다이어그램을 만듭니다.
• 03데이터베이스를 문서 또는 다른 데이터베이스와 비교합니다.
• 04필수 설명이나 컬럼 수 제한 같은 설정 가능한 규칙으로 스키마를 검사합니다.
• 05테이블과 컬럼의 문서화 범위를 측정합니다.
• 06PostgreSQL, MySQL, SQLite, BigQuery, MongoDB 등 다양한 데이터베이스를 지원합니다.

활용 사례

• 데이터베이스 스키마 문서를 저장소에 두고 코드 변경과 함께 최신 상태로 유지합니다.
• 스키마 변경으로 문서가 깨지거나 lint 규칙을 위반하면 CI 빌드를 실패 처리합니다.
• 운영 데이터베이스를 스테이징 또는 로컬 데이터베이스와 비교합니다.
• 개발자가 아닌 이해관계자의 검토를 위해 스키마 정의를 Excel 또는 PlantUML로 내보냅니다.

빠른 시작

1. 1

   Homebrew로 설치

   brew install tbls
2. 2

   명령어 하나로 데이터베이스 문서화

   tbls doc postgres://dbuser:dbpass@hostname:5432/dbname

사용 전 알아둘 점

• !실행 중인 데이터베이스를 문서화하므로 연결 가능한 데이터베이스와 인증 정보가 필요합니다.

토픽

자주 묻는 질문

tbls은(는) 무엇인가요?

실시간 데이터베이스 스키마에서 GFM Markdown 문서를 생성하고, CI에서 diff, lint, ER 다이어그램을 지원하는 Go CLI입니다. tbls는 데이터베이스에 연결해 스키마를 읽고 테이블, 컬럼, 인덱스, 제약 조건, 관계를 담은 탐색 가능한 Markdown 문서를 생성합니다. ER 다이어그램을 SVG, PNG, JPG 또는 Mermaid 형식으로 만들 수 있으며, DOT, PlantUML, JSON, YAML, Excel 등의 형식으로 스키마를 내보낼 수도 있습니다.

tbls은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

tbls은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

tbls은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. tbls의 마지막 커밋은 2026년 10월 15일입니다.

tbls은(는) 어디에 사용할 수 있나요?

데이터베이스 스키마 문서를 저장소에 두고 코드 변경과 함께 최신 상태로 유지합니다. 스키마 변경으로 문서가 깨지거나 lint 규칙을 위반하면 CI 빌드를 실패 처리합니다. 운영 데이터베이스를 스테이징 또는 로컬 데이터베이스와 비교합니다. 개발자가 아닌 이해관계자의 검토를 위해 스키마 정의를 Excel 또는 PlantUML로 내보냅니다.

tbls는 어떻게 설치하나요?

Homebrew로 설치: brew install tbls 명령어 하나로 데이터베이스 문서화: tbls doc postgres://dbuser:dbpass@hostname:5432/dbname

tbls은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/k1LoW/tbls