pipeline view
Overview
Create and preview a mermaid diagram of the pipeline
Aliases: view, render
Usage:
Options:
--directory <directory>: If specified, it will use that directory instead of the current one
How It Works
The quix pipeline view command generates a visual representation of your pipeline using a mermaid diagram. When executed, it creates or updates the pipeline.md and quix-pipeline.html files in your project directory.
These files contain mermaid code that visualizes your pipeline's structure and data flow. The command can open these files in your default browser, providing an interactive and up-to-date view of your pipeline configuration. This helps you easily visualize and document your pipeline setup.
Example Usage
This command updates the pipeline.md and a temporary quix-pipeline.html file, which opens automatically in your browser. This allows you to view and interact with your pipeline documentation directly.This command will attempt to open the generated quix-pipeline.html file in your default browser. If it does not open automatically, you will see a message with a file path like this:
Visual Studio Code can display the pipeline diagram if you install the Markdown Mermaid extension.
Similarly, GitHub will automatically render the pipeline.md file with the included mermaid code, allowing you to visualize your pipeline directly on the platform.
The quix-pipeline.html file will render a graphical representation of the pipeline in your default web browser:
Tip
Both pipeline.md and quix-pipeline.html are automatically updated every time the quix.yaml file is modified using the Quix CLI. This ensures that your documentation remains current with the latest configuration changes.
Info
If, for any reason, the CLI fails to open your browser and detects that Visual Studio Code (VS Code) is installed, it will automatically open the pipeline visualization in VS Code instead.