{"repo":"k1LoW/tbls","free":true,"listed":false,"github":"https://github.com/k1LoW/tbls","clone":"git clone https://github.com/k1LoW/tbls.git","description":"tbls is a CI-Friendly tool to document a database, written in Go.","language":"Go","stars":4320,"topics":["database-schema","mysql","database-document","documentation-tool","postgresql","sqlite","bigquery","spanner","redshift","sqlserver"],"license":"MIT","category":"databases-storage","readme_excerpt":"tbls (pronounced /ˈteɪbl̩z/) is a CI-Friendly tool to document a database, written in Go. Key features of tbls are: - Document a database automatically in GFM format. Output database schema in many formats. - Single binary = CI-Friendly. - Support many databases. - Work as linter for database Table of Contents - Quick Start - Install - Getting Started - Document a database - Diff database and (document or database) - Lint a database - Measure document coverage - Continuous Integration - Configuration - Name - Description - Labels - DSN - Support Datasource - Document path - Document format - ER diagram - Filter tables - Lint - Comments - Relations - Viewpoints - Dictionary - Personalized Templates - Required Version - Expand environment variables - Output formats - Command arguments - Environment variables Quick Start Document a database with one command. Using docker image. Install deb: RPM: Homebrew: MacPorts: aqua: Manually: Download binary from releases page go install: Docker: On GitHub Actions: :octocat: A GitHub Action for tbls is here. Temporary: Getting Started Document a database Add .tbls.yml (or tbls.yml ) file to your repository. Notice: If you are using a symbol such as # Notice: tbls diff shows the difference Markdown documents only. Re-generating database documentation Existing documentation can re-generated using either --force or --rm-dist flag. --force forces overwrite of the existing documents. It does not, however, remove files of removed tables. --rm-dis","default_branch":null,"files":null,"tree":[],"storefront":"/r/k1LoW","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/k1LoW/tbls/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}