Rider plugin

Step-by-step: set up your Rider workflow

Use this walkthrough to install the plugin, configure it for your current Rider project, and run LINQ against your real EF Core DbContext.

1. Install prerequisites

   The Rider plugin shells out to the efvibe CLI, so install the CLI first.

   • .NET SDK - same major version as your EF project.
   • efvibe CLI - install from NuGet, restore it as a local tool, or build it from source.

   dotnet tool install --global efvibe
   # or, in a repo with a dotnet-tools manifest:
   dotnet tool restore

   

2. Install the plugin

   Recommended: install from the JetBrains Marketplace.

   In Rider:

   1. Open Settings > Plugins.
   2. Open the Marketplace tab.
   3. Search for efvibe or My EF Vibe.
   4. Click Install and restart Rider when prompted.

   From a browser, open plugins.jetbrains.com/plugin/31961-my-ef-vibe and use Install to Rider.

   Alternative: for local development builds, use Settings > Plugins > gear > Install Plugin from Disk... and select the ZIP from rider-extension/build/distributions/.

   

3. Open your solution

   Open the .NET solution that contains your EF Core project. Relative paths in settings resolve from the Rider project or solution directory.

   

4. Configure project settings

   Open Settings > Languages & Frameworks > My EF Vibe for the current project.

   Setting	What to enter
   EF project	The .csproj that contains or references your DbContext.
   Startup project	The app project with appsettings*.json or user secrets.
   DbContext	The context type name, for example AdventureWorksDbContext.
   Workspace root	Optional session/output root. Leave blank to use the CLI default.
   Provider / connection string	Optional overrides when the startup project does not provide configuration.
   efvibe executable	Optional explicit path to efvibe or myefvibe.

   Paths can be absolute, solution-relative, or use ${workspaceFolder} / $(SolutionDir).

   EF project: src/AdventureWorks.Infrastructure.Persistence/AdventureWorks.Infrastructure.Persistence.csproj
   Startup project: src/AdventureWorks.API/AdventureWorks.API.csproj
   DbContext: AdventureWorksDbContext

   Rider stores these settings per project in workspace state, usually .idea/workspace.xml or .idea/.idea.<SolutionName>/.idea/workspace.xml. Look for MyEfVibeSettings. This user-local file normally should not be committed.

   

5. Open the tool window

   Open View > Tool Windows > My EF Vibe. The tool window defaults to the right side of Rider.

   The tool window includes a resizable query editor and tabs for Result, SQL, Plan, Messages, Session, Model, Scan Review, History, and Notebook.

   

6. Run a LINQ query

   Type a query using db as the current DbContext, then click Run.

   db.BusinessEntityAddresses
       .AsNoTracking()
       .Where(x => x.BusinessEntityId >=1)
       .Include(x => x.AddressType)
       .Include(x => x.Address)
           .ThenInclude(a => a.StateProvince)
           .ThenInclude(s => s.CountryRegion)
       .ToList(cancellationToken);

   The Result tab shows rows returned by the query. Use Export CSV or Export JSON in the Result tab to export the last successful run.

   Click Run Plan to execute the query and immediately open the Plan tab.

   

7. Inspect the model

   Open the Model tab to explore the configured DbContext.

   • Db Info loads provider, connection, and DbContext details.
   • Tables loads DbSets and entity types.
   • Run Count counts rows for the selected DbSet.
   • Run Sample runs Take(10) for the selected DbSet.
   • Describe shows entity metadata.

   

8. Review scan findings

   Click Scan Lite or Scan Deep. Results open in the Scan Review tab.

   • Previous and Next move between findings.
   • Go to code opens the source location.
   • Note saves a note for the selected finding.
   • Dismiss hides the selected finding from future scans that respect dismissals.

   Deep scan includes translated SQL and provider query plans per finding. Aggregate probes (Count(), Any(), …) translate to correct SQL in 0.6.x.

9. Use notebooks

   Open the Notebook tab to run multiple cells. Separate cells with ---.

   db.Products.Take(10)
   
   ---
   :dbinfo
   
   ---
   db.SalesOrderHeaders.Count()

   Each cell has Code and Result sub-tabs so you can edit the expression and read output side by side. Use Open and Save for .efvibe-notebook files. Click Run All to execute every cell.