# bruin-data/bruin-vscode architecture

> Architecture diagram of the GitHub repository bruin-data/bruin-vscode, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bruin-data/bruin-vscode
- Repository: https://github.com/bruin-data/bruin-vscode

## Overview

Bruin is a VS Code extension for developing and operating Bruin data products. Users manage assets and connections, run or validate work, and inspect results through extension panels and webviews; the README also documents lineage, database browsing, query preview, table diff, run history, and configuration autocomplete. The sampled query path runs from the preview panel through query commands to Bruin CLI output handling. Several feature modules are unsampled, so their documented capabilities are shown without speculative internal call chains.

Main entry points: [`src/extension/extension.ts`](https://github.com/bruin-data/bruin-vscode/blob/main/src/extension/extension.ts) (Extension Activation), [`src/panels/BruinPanel.ts`](https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/BruinPanel.ts) (Asset Details), [`src/panels/QueryPreviewPanel.ts`](https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/QueryPreviewPanel.ts) (Query Preview), [`src/panels/DacPreviewPanel.ts`](https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/DacPreviewPanel.ts) (Dashboard Preview)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_extension["VS Code Extension"]
  node_extension["Extension Activation<br/>[extension.ts]"]
  node_config["Extension Settings<br/>[configuration.ts]"]
  node_connections["Connections"]
  node_database["Database Explorer"]
  node_autocomplete["Config Completion"]
  node_nonce["Webview Nonce<br/>[getNonce.ts]"]
  node_uri["Webview URI<br/>[getUri.ts]"]
end

subgraph group_assets["Asset Workflow"]
  node_asset_panel["Asset Details<br/>[BruinPanel.ts]"]
  node_asset_ui["Asset Webview<br/>[App.vue]"]
  node_asset_parse["Asset Parsing"]
  node_asset_run["Run and Validate<br/>[bruinCommand.ts]"]
  node_helpers["Asset Utilities<br/>[helperUtils.ts]"]
  node_materialization["Materialization Editor"]
end

subgraph group_insight["Data Insights"]
  node_lineage_panel["Asset Lineage<br/>[LineagePanel.ts]"]
  node_lineage_ui["Lineage Visualization"]
  node_query_panel["Query Preview"]
  node_query_ui["Query Results UI<br/>[QueryPreview.vue]"]
  node_table_diff["Table Diff<br/>[TableDiffPanel.ts]"]
  node_run_history["Run History<br/>[RunHistoryPanel.ts]"]
  node_table_details["Table Details"]
  node_dac_panel["Dashboard Preview<br/>[DacPreviewPanel.ts]"]
end

subgraph group_runtime["CLI Runtime"]
  node_query_commands["Query Commands<br/>[queryCommands.ts]"]
  node_query_output["Query Execution<br/>[queryOutput.ts]"]
  node_export_output["Result Export"]
  node_dac_server["Dashboard Server<br/>[dacServe.ts]"]
  node_bruincmd["Bruin CLI Access<br/>[bruinCommand.ts]"]
  node_bruinsvc["CLI Discovery"]
  node_dacsvc["DAC Discovery"]
  node_install_cli["CLI Installation<br/>[bruinInstallCli.ts]"]
  node_dac_install["DAC Installation<br/>[dacInstallCli.ts]"]
end

node_user(("Data Engineer"))

node_user -->|"uses in VS Code"| node_extension
node_extension -->|"registers"| node_lineage_panel
node_extension -->|"registers"| node_query_panel
node_extension -->|"registers"| node_table_diff
node_extension -->|"registers"| node_run_history
node_extension -->|"registers"| node_dac_panel
node_user -->|"views and edits"| node_asset_panel
node_asset_panel -.->|"presents details"| node_asset_ui
node_user -->|"manages connections"| node_connections
node_user -->|"browses tables"| node_database
node_user -->|"gets completions"| node_autocomplete
node_user -->|"explores lineage"| node_lineage_panel
node_lineage_panel -.->|"renders lineage"| node_lineage_ui
node_user -->|"previews queries"| node_query_panel
node_query_panel -->|"requests output"| node_query_commands
node_query_commands -->|"runs query"| node_query_output
node_query_commands -->|"exports results"| node_export_output
node_query_output -->|"executes command"| node_bruincmd
node_query_commands -->|"gets executable"| node_bruinsvc
node_user -->|"compares tables"| node_table_diff
node_user -->|"reviews runs"| node_run_history
node_user -->|"opens metadata"| node_table_details
node_user -->|"previews dashboards"| node_dac_panel
node_dac_panel -->|"starts preview"| node_dac_server
node_dac_panel -->|"checks version"| node_dacsvc
node_dac_panel -->|"installs if needed"| node_dac_install
node_dac_server -->|"resolves executable"| node_dacsvc
node_dac_server -->|"resolves CLI"| node_bruinsvc
node_user -->|"runs or validates"| node_asset_run
node_asset_panel -->|"requests parsing"| node_asset_parse
node_asset_panel -->|"offers installation"| node_install_cli
node_asset_panel -->|"uses utilities"| node_helpers
node_query_panel -->|"builds webview"| node_nonce
node_query_panel -->|"builds webview"| node_uri
node_config -->|"provides timeout"| node_query_output
node_asset_ui -->|"includes editor"| node_materialization

click node_extension "https://github.com/bruin-data/bruin-vscode/blob/main/src/extension/extension.ts"
click node_config "https://github.com/bruin-data/bruin-vscode/blob/main/src/extension/configuration.ts"
click node_asset_panel "https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/BruinPanel.ts"
click node_asset_ui "https://github.com/bruin-data/bruin-vscode/blob/main/webview-ui/src/App.vue"
click node_asset_parse "https://github.com/bruin-data/bruin-vscode/blob/main/src/extension/commands/parseAssetCommand.ts"
click node_asset_run "https://github.com/bruin-data/bruin-vscode/blob/main/src/bruin/bruinCommand.ts"
click node_connections "https://github.com/bruin-data/bruin-vscode/blob/main/src/extension/commands/manageConnections.ts"
click node_database "https://github.com/bruin-data/bruin-vscode/blob/main/src/providers/ActivityBarConnectionsProvider.ts"
click node_autocomplete "https://github.com/bruin-data/bruin-vscode/blob/main/src/language-server/bruinLanguageServer.ts"
click node_lineage_panel "https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/LineagePanel.ts"
click node_lineage_ui "https://github.com/bruin-data/bruin-vscode/blob/main/webview-ui/src/components/lineage-flow/pipeline-lineage/pipelineLineageBuilder.ts"
click node_query_panel "https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/QueryPreviewPanel.ts"
click node_query_commands "https://github.com/bruin-data/bruin-vscode/blob/main/src/extension/commands/queryCommands.ts"
click node_query_output "https://github.com/bruin-data/bruin-vscode/blob/main/src/bruin/queryOutput.ts"
click node_export_output "https://github.com/bruin-data/bruin-vscode/blob/main/src/bruin/exportQueryOutput.ts"
click node_query_ui "https://github.com/bruin-data/bruin-vscode/blob/main/webview-ui/src/components/query-output/QueryPreview.vue"
click node_table_diff "https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/TableDiffPanel.ts"
click node_run_history "https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/RunHistoryPanel.ts"
click node_table_details "https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/TableDetailsPanel.ts"
click node_dac_panel "https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/DacPreviewPanel.ts"
click node_dac_server "https://github.com/bruin-data/bruin-vscode/blob/main/src/bruin/dacServe.ts"
click node_bruincmd "https://github.com/bruin-data/bruin-vscode/blob/main/src/bruin/bruinCommand.ts"
click node_bruinsvc "https://github.com/bruin-data/bruin-vscode/blob/main/src/providers/BruinExecutableService.ts"
click node_dacsvc "https://github.com/bruin-data/bruin-vscode/blob/main/src/providers/DacExecutableService.ts"
click node_install_cli "https://github.com/bruin-data/bruin-vscode/blob/main/src/bruin/bruinInstallCli.ts"
click node_dac_install "https://github.com/bruin-data/bruin-vscode/blob/main/src/bruin/dacInstallCli.ts"
click node_helpers "https://github.com/bruin-data/bruin-vscode/blob/main/src/utilities/helperUtils.ts"
click node_nonce "https://github.com/bruin-data/bruin-vscode/blob/main/src/utilities/getNonce.ts"
click node_uri "https://github.com/bruin-data/bruin-vscode/blob/main/src/utilities/getUri.ts"
click node_materialization "https://github.com/bruin-data/bruin-vscode/blob/main/webview-ui/src/components/asset/materialization/Materialization.vue"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_extension,node_config,node_connections,node_database,node_autocomplete,node_nonce,node_uri toneBlue
class node_asset_panel,node_asset_ui,node_asset_parse,node_asset_run,node_helpers,node_materialization toneAmber
class node_lineage_panel,node_lineage_ui,node_query_panel,node_query_ui,node_table_diff,node_run_history,node_table_details,node_dac_panel toneMint
class node_query_commands,node_query_output,node_export_output,node_dac_server,node_bruincmd,node_bruinsvc,node_dacsvc,node_install_cli,node_dac_install toneRose
class node_user toneIndigo
```

## Components

### VS Code Extension

- [Extension Activation](https://github.com/bruin-data/bruin-vscode/blob/main/src/extension/extension.ts): `src/extension/extension.ts`
- [Extension Settings](https://github.com/bruin-data/bruin-vscode/blob/main/src/extension/configuration.ts): `src/extension/configuration.ts`
- [Connections](https://github.com/bruin-data/bruin-vscode/blob/main/src/extension/commands/manageConnections.ts): `src/extension/commands/manageConnections.ts`
- [Database Explorer](https://github.com/bruin-data/bruin-vscode/blob/main/src/providers/ActivityBarConnectionsProvider.ts): `src/providers/ActivityBarConnectionsProvider.ts`
- [Config Completion](https://github.com/bruin-data/bruin-vscode/blob/main/src/language-server/bruinLanguageServer.ts): `src/language-server/bruinLanguageServer.ts`
- [Webview Nonce](https://github.com/bruin-data/bruin-vscode/blob/main/src/utilities/getNonce.ts): `src/utilities/getNonce.ts`
- [Webview URI](https://github.com/bruin-data/bruin-vscode/blob/main/src/utilities/getUri.ts): `src/utilities/getUri.ts`

### Asset Workflow

- [Asset Details](https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/BruinPanel.ts): `src/panels/BruinPanel.ts`
- [Asset Webview](https://github.com/bruin-data/bruin-vscode/blob/main/webview-ui/src/App.vue): `webview-ui/src/App.vue`
- [Asset Parsing](https://github.com/bruin-data/bruin-vscode/blob/main/src/extension/commands/parseAssetCommand.ts): `src/extension/commands/parseAssetCommand.ts`
- [Run and Validate](https://github.com/bruin-data/bruin-vscode/blob/main/src/bruin/bruinCommand.ts): `src/bruin/bruinCommand.ts`
- [Asset Utilities](https://github.com/bruin-data/bruin-vscode/blob/main/src/utilities/helperUtils.ts): `src/utilities/helperUtils.ts`
- [Materialization Editor](https://github.com/bruin-data/bruin-vscode/blob/main/webview-ui/src/components/asset/materialization/Materialization.vue): `webview-ui/src/components/asset/materialization/Materialization.vue`

### Data Insights

- [Asset Lineage](https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/LineagePanel.ts): `src/panels/LineagePanel.ts`
- [Lineage Visualization](https://github.com/bruin-data/bruin-vscode/blob/main/webview-ui/src/components/lineage-flow/pipeline-lineage/pipelineLineageBuilder.ts): `webview-ui/src/components/lineage-flow/pipeline-lineage/pipelineLineageBuilder.ts`
- [Query Preview](https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/QueryPreviewPanel.ts): `src/panels/QueryPreviewPanel.ts`
- [Query Results UI](https://github.com/bruin-data/bruin-vscode/blob/main/webview-ui/src/components/query-output/QueryPreview.vue): `webview-ui/src/components/query-output/QueryPreview.vue`
- [Table Diff](https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/TableDiffPanel.ts): `src/panels/TableDiffPanel.ts`
- [Run History](https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/RunHistoryPanel.ts): `src/panels/RunHistoryPanel.ts`
- [Table Details](https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/TableDetailsPanel.ts): `src/panels/TableDetailsPanel.ts`
- [Dashboard Preview](https://github.com/bruin-data/bruin-vscode/blob/main/src/panels/DacPreviewPanel.ts): `src/panels/DacPreviewPanel.ts`

### CLI Runtime

- [Query Commands](https://github.com/bruin-data/bruin-vscode/blob/main/src/extension/commands/queryCommands.ts): `src/extension/commands/queryCommands.ts`
- [Query Execution](https://github.com/bruin-data/bruin-vscode/blob/main/src/bruin/queryOutput.ts): `src/bruin/queryOutput.ts`
- [Result Export](https://github.com/bruin-data/bruin-vscode/blob/main/src/bruin/exportQueryOutput.ts): `src/bruin/exportQueryOutput.ts`
- [Dashboard Server](https://github.com/bruin-data/bruin-vscode/blob/main/src/bruin/dacServe.ts): `src/bruin/dacServe.ts`
- [Bruin CLI Access](https://github.com/bruin-data/bruin-vscode/blob/main/src/bruin/bruinCommand.ts): `src/bruin/bruinCommand.ts`
- [CLI Discovery](https://github.com/bruin-data/bruin-vscode/blob/main/src/providers/BruinExecutableService.ts): `src/providers/BruinExecutableService.ts`
- [DAC Discovery](https://github.com/bruin-data/bruin-vscode/blob/main/src/providers/DacExecutableService.ts): `src/providers/DacExecutableService.ts`
- [CLI Installation](https://github.com/bruin-data/bruin-vscode/blob/main/src/bruin/bruinInstallCli.ts): `src/bruin/bruinInstallCli.ts`
- [DAC Installation](https://github.com/bruin-data/bruin-vscode/blob/main/src/bruin/dacInstallCli.ts): `src/bruin/dacInstallCli.ts`

### Other components

- **Data Engineer**

## Connections

- Data Engineer → Extension Activation: uses in VS Code (evidence: `README.md`)
- Extension Activation → Asset Lineage: registers (evidence: `src/extension/extension.ts`)
- Extension Activation → Query Preview: registers (evidence: `src/extension/extension.ts`)
- Extension Activation → Table Diff: registers (evidence: `src/extension/extension.ts`)
- Extension Activation → Run History: registers (evidence: `src/extension/extension.ts`)
- Extension Activation → Dashboard Preview: registers (evidence: `src/extension/extension.ts`)
- Data Engineer → Asset Details: views and edits (evidence: `README.md`)
- Asset Details → Asset Webview: presents details
- Data Engineer → Connections: manages connections (evidence: `README.md`)
- Data Engineer → Database Explorer: browses tables (evidence: `README.md`)
- Data Engineer → Config Completion: gets completions (evidence: `README.md`)
- Data Engineer → Asset Lineage: explores lineage (evidence: `README.md`)
- Asset Lineage → Lineage Visualization: renders lineage
- Data Engineer → Query Preview: previews queries (evidence: `README.md`)
- Query Preview → Query Commands: requests output (evidence: `src/panels/QueryPreviewPanel.ts`)
- Query Commands → Query Execution: runs query (evidence: `src/extension/commands/queryCommands.ts`)
- Query Commands → Result Export: exports results (evidence: `src/extension/commands/queryCommands.ts`)
- Query Execution → Bruin CLI Access: executes command (evidence: `src/bruin/queryOutput.ts`)
- Query Commands → CLI Discovery: gets executable (evidence: `src/extension/commands/queryCommands.ts`)
- Data Engineer → Table Diff: compares tables (evidence: `README.md`)
- Data Engineer → Run History: reviews runs (evidence: `README.md`)
- Data Engineer → Table Details: opens metadata (evidence: `README.md`)
- Data Engineer → Dashboard Preview: previews dashboards (evidence: `README.md`)
- Dashboard Preview → Dashboard Server: starts preview (evidence: `src/panels/DacPreviewPanel.ts`)
- Dashboard Preview → DAC Discovery: checks version (evidence: `src/panels/DacPreviewPanel.ts`)
- Dashboard Preview → DAC Installation: installs if needed (evidence: `src/panels/DacPreviewPanel.ts`)
- Dashboard Server → DAC Discovery: resolves executable (evidence: `src/bruin/dacServe.ts`)
- Dashboard Server → CLI Discovery: resolves CLI (evidence: `src/bruin/dacServe.ts`)
- Data Engineer → Run and Validate: runs or validates (evidence: `README.md`)
- Asset Details → Asset Parsing: requests parsing (evidence: `src/panels/BruinPanel.ts`)
- Asset Details → CLI Installation: offers installation (evidence: `src/panels/BruinPanel.ts`)
- Asset Details → Asset Utilities: uses utilities (evidence: `src/panels/BruinPanel.ts`)
- Query Preview → Webview Nonce: builds webview (evidence: `src/panels/QueryPreviewPanel.ts`)
- Query Preview → Webview URI: builds webview (evidence: `src/panels/QueryPreviewPanel.ts`)
- Extension Settings → Query Execution: provides timeout (evidence: `src/bruin/queryOutput.ts`)
- Asset Webview → Materialization Editor: includes editor (evidence: `webview-ui/src/App.vue`)
