Announcing Liam ERD Integration with tbls

We're excited to announce that Liam ERD now supports schema.json files generated by tbls, the popular CI-friendly database documentation tool! Through collaboration with tbls creator @K1LoW, we've made it easier than ever to enhance your database documentation with interactive ER diagrams.

If you have published your schema.json in a public repository, simply add liambx.com/erd/p/ at the beginning to display an interactive ER diagrams!
https://liambx.com/erd/p/github.com/k1LoW/tbls/blob/v1.81.0/sample/mysql/schema.json

Why Liam ERD and tbls Integration Matters

tbls is a powerful database documentation tool that generates schema documentation from various databases, much loved by developers as CI-friendly.
While Liam ERD previously focused primarily on PostgreSQL support, our integration with tbls now enables visualization for a wider range of databases that tbls supports(MySQL SQLite, BigQuery, and more!), making Liam ERD accessible to more database projects than ever before.

Getting Started

The integration is straightforward and works with your existing tbls setup. Here's how to get started:

Using the Web Version

tbls doc generates a schema.json file as part of its output. To view it in Liam ERD, simply prepend liambx.com/erd/p/ to your schema.json URL.

For example, if your schema.json is stored at:
https://github.com/k1LoW/tbls/blob/v1.81.0/sample/mysql/schema.json

Just add liambx.com/erd/p/ to the front to view the interactive ER diagram!
https://liambx.com/erd/p/github.com/k1LoW/tbls/blob/v1.81.0/sample/mysql/schema.json

Using the CLI Version

For private projects or local development, you can use our CLI tool:

# Generate JSON schema with tbls
$ tbls out -t json schema.json
 
# Generate ER diagram with Liam ERD
$ npx @liam-hq/cli erd build --format tbls --input schema.json
 
# View the result
$ npx serve dist

We've prepared a sample project that demonstrates how to automatically generate database documentation using tbls and Liam ERD in CI for MySQL projects. Check it out!

• GitHub Actions: .github/workflows/mysql-with-tbls.yml
• source code: samples/mysql-with-tbls

Try It Today

Ready to enhance your database documentation with interactive ER diagrams? Check out our detailed documentation to get started.

We'd love to hear your feedback and suggestions as you use this integration. Feel free to open issues or discussions on our GitHub repository!
Special thanks to @K1LoW for his collaboration and support in making this integration possible!