hubql

Hubql CLI

Hubql is a collaboration platform for data schemas. We aim to enhance the experience of developers and stakeholders in building and managing data models and API schemas.

With the Hubql CLI you are able to generate preview links for collaboration with others for your JSON, GraphQL, Prisma, XML and Protobuf files.

You can also generate documentation and download diagrams to your local machine.

Note: Hubql CLI sends your selected file's content to Hubql to generate preview links for collaboration.

Features

• ER Diagram Visualization: Convert Prisma schema into interactive ER diagrams, making it easier to understand and document data models.
• Prisma Schema Integration: Integrate your Prisma data model schema directly from your working repository.
• JSON Schema Visualization: Publish your JSON data models as visualization.

Installation

To install Hubql CLI, run the following command in your terminal or skip installation using npx commands:

npm install -g hubql

Commands

• init: Initialize a new Hubql project.

  Usage:

  hubql init

• login: Authenticate your local machine through the Hubql website and store an access token. This allows the user to use the CLI as an authorized user for various purposes.

  Usage:

  hubql login

• push: This command searches for matching files in your working directory and pushes your files to Hubql for collaboration and generate documentation.

  Usage:

  hubql push

  Options: Generate a diagram in png (login required)

  hubql push -s

  Generate a diagram in png and create a Readme in Hubql folder (login required)

  hubql push -s -d

• logout: Remove the current session from the CLI, logging the user out of the Hubql platform.

  Usage:

  hubql logout

Getting Started

1. Install Hubql CLI: Follow the installation instructions above.
2. (Optional) Login: Use the login command to authenticate.
3. Initialize Your Project: Run the init command in your project directory where your files schema is located. If the init command is used without logging in, you will be using Hubql as a guest user.
4. Push: Run push to publish your files to Hubql and generate documentation.
5. Collaborate and Visualize: Use the Hubql platform for live collaboration and ER diagram visualization.

Version

Current version of Hubql CLI: 0.0.12

Support

For support, issues, or further documentation, please visit our website.