Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@liam-hq/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@liam-hq/cli

Command-line tool designed to generate a web application that displays ER diagrams.

$ liam erd build --input {your .sql} --format postgres
# Outputs the web application to the ./public and ./dist directories

# Or use a `db/schema.rb` file (from your Ruby on Rails app).
$ liam erd build --input {your schema.rb} --format schemarb
# Outputs the web application to the `./dist` directory

$ liam erd preview
# Launches the web application for preview

Test

pnpm run test

Building and Installing the Standalone CLI for Development

To build the CLI for development purposes, run:

pnpm run build
# The executable will be output to dist-cli/bin/cli.js.

After building, you can invoke it locally with:

node ./dist-cli/bin/cli.js erd build --input ./fixtures/input.schema.rb --format schemarb

To make it globally accessible as liam, use:

pnpm link --global

Development npm Scripts Explanation

ER Diagram App Development with Vite

Dev Command
```
pnpm dev
```
This command currently performs the following actions:
- Builds the CLI.
- Executes the CLI with the command erd build --input ./fixtures/input.schema.rb --format schemarb.
- Copies the generated schema.json to the public/ directory and launches the Vite development server.

Project File Structure

bin/cli.ts: This is the main CLI script.
src/cli/: Contains the source code for the CLI.
fixtures/input.schema.rb: A sample input file used for testing and development purposes.
src/{App,main}.tsx, index.html: These files constitute the web application's entry point, which displays ER diagrams.