Bruin CLI

Appearance

Editor Experience ​

These in-editor features appear automatically based on file context or environment setup, helping you take quick action without leaving the editor.

CLI Installation Prompt ​

If the Bruin CLI is not installed, the extension helps you get set up with minimal friction.

  • Trigger Condition

    • Triggered when you click the Render button and the CLI is missing.

  • How It Works

    • An alert is shown in the side panel.
    • A "Install CLI" button allows you to install the CLI immediately.

Install Bruin CLI

File Conversion ​

When you open a file that isn't yet a Bruin asset but is eligible for conversion, the extension displays an alert offering a conversion option.

  • Eligible File Types:

    • .sql and .py: Converted using the patch-asset command.
    • .yml: Converted by renaming to *.asset.yml.

  • How It Works:

    • An alert appears when an eligible file is opened.
    • A "Convert to Asset" button is provided to initiate the conversion directly.

    Convert file to Bruin asset

Query Preview CodeLens ​

The extension offers an inline "Preview" button, leveraging CodeLens functionality, which appears above top-level queries in your SQL files. This feature provides a direct access to query previews from within the editor.

  • Functionality
    • The "Preview" button is automatically displayed above each top-level query in your SQL files.
    • Clicking the button initiates query execution, displaying the results in the Query Preview Panel within the current tab.
    • This feature replicates the functionality of the Query Preview Panel.
  • Subquery Functionality
    • When a subquery is selected and the "Preview" button is clicked, the results of the subquery are displayed.

CodeLens Preview Button