Installation

Installing DBeagle

Requirements

• VS Code 1.96.0 or later
• A local desktop environment supported by the current preview build:
  • macOS Apple Silicon
  • macOS Intel
  • Linux x64
  • Windows x64
• A reachable Trino, PostgreSQL, MySQL, SQL Server, or Vertica database

You do not need Node.js or Rust to install DBeagle as a user.

Virtual workspaces are not supported in the current preview release.

Install from the Marketplace

This is the recommended path for most users.

1. Open VS Code.
2. Open the Extensions view with Cmd/Ctrl+Shift+X.
3. Search for DBeagle.
4. Install the extension published as PrasadPathak.dbeagle.

DBeagle in the VS Code Marketplace.

Install from a VSIX

If you are testing a preview build, you can install from a .vsix file:

1. Open VS Code.
2. Open the Extensions view.
3. Open the ... menu in the top-right corner.
4. Choose Install from VSIX....
5. Select the DBeagle VSIX you were given.

Verify the install

After installation, you should see:

• A DBeagle icon in the Activity Bar
• A Connections view
• A Scratches view
• A Parameters view
• A Query Outline view
• A DBeagle Results panel container

If the icon does not appear right away, reload the window once from the Command Palette with Developer: Reload Window.

DBeagle open in VS Code after installation.

Install from source

If you are contributing to DBeagle itself, use the extension repo rather than the website repo:

git clone https://github.com/prasaddpathak/dbeagle.git
cd dbeagle
npm ci
npm run build

Open the repo in VS Code and press F5 to launch an Extension Development Host. See Contributing for the current developer workflow.

Next steps

• Quick Start
• Managing Connections