VS Code extension

Step-by-step: set up your VS Code workflow

This walkthrough takes you from a clean machine to running LINQ against your real DbContext, scanning the repo, and reviewing SQL — all inside VS Code.

1. Install prerequisites

   You need the .NET SDK and the efvibe CLI (the extension shells out to it).

   • .NET SDK — same major version as your EF project (8, 9, or 10).
   • efvibe CLI — install from NuGet or build from the my-ef-vibe repo:

     dotnet tool install -g efvibe
     # or, for latest features:
     dotnet build src/MyEfVibe/MyEfVibe.csproj -c Release

   

2. Install the VS Code extension

   Recommended: install from the Visual Studio Marketplace.

   In VS Code or Cursor:

   1. Open Extensions (Cmd+Shift+X / Ctrl+Shift+X).
   2. Search for efvibe (display name My EF Vibe, publisher yeahbah).
   3. Click Install and reload the window if prompted.

   From a terminal:

   code --install-extension yeahbah.vscode-efvibe

   Alternative: install a .vsix from GitHub Releases via Install from VSIX… (pre-release or offline installs). See INSTALL.md.

   

3. Open your EF solution workspace

   Use File → Open Folder on the repository root (the folder that contains your .sln or the project with your DbContext). The extension reads efvibe.* settings from .vscode/settings.json or user settings.

   

4. Configure workspace settings

   Create or edit .vscode/settings.json. Point efvibe.project at the .csproj that contains your DbContext, and set efvibe.context when you have more than one context.

   {
     "efvibe.project": "${workspaceFolder}/src/MyApp.Persistence/MyApp.Persistence.csproj",
     "efvibe.startupProject": "${workspaceFolder}/src/MyApp.Api/MyApp.Api.csproj",
     "efvibe.context": "AppDbContext",
     "efvibe.dotnetFramework": "net8.0",
     "efvibe.dbLog": true,
     "efvibe.useDaemon": true,
     "efvibe.resultDestination": "panel",
     "efvibe.scan.openReviewOnScan": true
   }

   Optional: set efvibe.toolPath to a local myefvibe binary if you are developing the CLI from the same repo.

   

5. Verify prerequisites

   Open the Command Palette (Cmd+Shift+P / Ctrl+Shift+P) and run efvibe: Check Prerequisites. The output channel should report dotnet and efvibe on PATH with a version string.

   Then run efvibe: Refresh Status — the status bar should show your DbContext and provider.

   

6. Use the efvibe Session sidebar

   In the Explorer activity bar, open efvibe Session. At the top you will see your DbContext and DbSets (from efvibe --tables-json). Below that are session folders (scan, per-context exports) once you have run a scan or REPL query.

   Toolbar actions (left to right):

   • Scan Deep — workspace scan with SQL translation
   • Run Query — opens the result panel (pick a DbSet if none selected)
   • Start REPL — integrated terminal running efvibe
   • Refresh — reload model and session files

   Right-click a DbSet for Run Query, Describe, Go To Definition, or Run Count.

   

7. Run a LINQ query from the editor

   Typical loop for debugging repository code:

   1. Open a C# file with a LINQ query (handler or repository).
   2. Select the full expression (including await, DbContext, and parameters if needed).
   3. Press Shift+Alt+E or run efvibe: Run Selection.
   4. Or click Run with efvibe CodeLens on the first line of the query — it runs the whole statement.

   With efvibe.useDaemon (default true), the first run starts efvibe serve and builds your project; later runs reuse the warm DbContext. Edit stubbed parameter values in the panel and press Run again.

   

   

8. Scan the workspace (deep)

   From the Session toolbar, click Scan Deep, or run efvibe: Scan Workspace (Deep) from the Command Palette. Deep scan requires a resolvable DbContext (set efvibe.context when you have several).

   The CLI builds your EF project, walks sources, and attempts ToQueryString() per call site. Progress appears in the notification area; artifacts are written under ~/.efvibe/<Project>/<DbContext>/.

   

9. Review findings

   When efvibe.scan.openReviewOnScan is true (default), Scan Review opens automatically — one finding per page with rule, message, code, translated SQL, and plan (when available).

   • ← / → — previous and next finding
   • Location — jump to file and line
   • Note and Dismiss — persisted for the next scan when dismissals are respected
   • 📋 Copy on code, SQL, and plan blocks

   Re-open anytime with efvibe: Open Scan Review.

   

10. Start the REPL (optional)

    For exploratory work, click Start REPL in the Session toolbar or run efvibe: Start REPL. The integrated terminal runs efvibe with your workspace flags.

    Use efvibe: Send to REPL (Cmd+Shift+Enter / Ctrl+Shift+Enter in C#) to push the current selection as a one-line snippet. The REPL is separate from efvibe serve used by Run Selection.