Skip to main content

​
Installing from VS Code Marketplace

The easiest way to install DotNET Build Buddy is directly from the Visual Studio Code Marketplace.
1

Open VS Code Extensions

Open Visual Studio Code and click on the Extensions icon in the Activity Bar on the left side, or press Ctrl+Shift+X (Windows/Linux) or Cmd+Shift+X (macOS).
2

Search for the Extension

In the Extensions search box, type “DotNET Build Buddy” and press Enter.
3

Install the Extension

Find “DotNET Build Buddy” in the search results and click the Install button.
Publisher: DotNET-Build-Buddy
4

Verify Installation

Once installed, you’ll see the extension listed in your Extensions panel. The extension will activate automatically when you open a workspace containing .NET files.

​
Installing from VSIX File

If you have a .vsix file (for example, from a pre-release or custom build), you can install it manually.
1

Download the VSIX File

Obtain the .vsix file from your source (GitHub releases, internal distribution, etc.).
2

Open Extensions View

Press Ctrl+Shift+X (Windows/Linux) or Cmd+Shift+X (macOS) to open the Extensions view.
3

Install from VSIX

Click the ... (More Actions) button at the top of the Extensions view and select “Install from VSIX…”Navigate to your downloaded .vsix file and select it.
4

Reload VS Code

After installation, you may be prompted to reload VS Code. Click “Reload Now” to activate the extension.

​
Building from Source

Developers who want to contribute or customize the extension can build it from source.
Building from source is intended for developers. If you just want to use the extension, install it from the VS Code Marketplace instead.

​
Prerequisites

Before building from source, ensure you have:
  • Node.js version 20.x or higher
  • npm (comes with Node.js)
  • Git for cloning the repository
  • VS Code version 1.74.0 or higher

​
Build Steps

1

Clone the Repository

git clone https://github.com/MilesONerd/DotNET-Build-Buddy.git
cd DotNET-Build-Buddy
2

Install Dependencies

npm install
This installs all required packages including TypeScript, VS Code types, and dependencies like xml2js and glob.
3

Compile the Extension

npm run compile
This compiles the TypeScript source files in src/ to JavaScript in the out/ directory.
4

Package the Extension (Optional)

To create a .vsix file for distribution:
npm install -g @vscode/vsce
vsce package
This creates a .vsix file in the project root that you can install using the Installing from VSIX File method above.
5

Run in Development Mode

Open the project folder in VS Code:
code .
Press F5 to open a new Extension Development Host window with the extension loaded. This is useful for testing changes during development.

​
Development Workflow

When developing the extension: 
# Automatically recompile on file changes
npm run watch
For contribution guidelines, see the CONTRIBUTING.md file in the repository.

​
Verifying Installation

After installation, verify that DotNET Build Buddy is working correctly:
1

Open a .NET Workspace

Open a folder that contains .NET source files (.cs, .fs, or .vb) or existing project files.
2

Check Activation Message

When the extension activates, you should see a notification:
DotNET Build Buddy is ready to manage your .NET projects!
3

Verify Commands are Available

Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS) to open the Command Palette.Type “DotNET Build Buddy” to see available commands:
  • DotNET Build Buddy: Generate Solution File
  • DotNET Build Buddy: Update Project Files
  • DotNET Build Buddy: Refresh All .NET Files
4

Check Developer Console (Optional)

Open the Developer Console with Help > Toggle Developer Tools and look for console messages:
DotNET Build Buddy extension is now active!
DotNET Build Buddy: File watchers initialized successfully

​
Activation Events

DotNET Build Buddy activates automatically when VS Code detects any of the following files in your workspace:
  • **/*.cs - C# source files
  • **/*.fs - F# source files
  • **/*.vb - VB.NET source files
  • **/*.csproj - C# project files
  • **/*.fsproj - F# project files
  • **/*.vbproj - VB.NET project files
  • **/*.sln - Solution files
If you open a folder without any .NET files, the extension will remain inactive to conserve resources. Simply add a .NET file to activate it.

​
Troubleshooting Installation

Symptoms: No activation message appears, commands are not availableSolutions:
  • Ensure your workspace contains at least one .NET-related file (.cs, .fs, .vb, or project files)
  • Check the Extensions panel to verify the extension is installed and enabled
  • Reload VS Code with Ctrl+R (Windows/Linux) or Cmd+R (macOS)
  • Check for error messages in the Developer Console (Help > Toggle Developer Tools)
Symptoms: Error message during installation, installation hangsSolutions:
  • Check your internet connection
  • Verify you have the minimum required VS Code version (1.74.0 or higher)
  • Try restarting VS Code and attempting the installation again
  • Check VS Code’s output panel for detailed error messages
Symptoms: Compile errors, missing dependenciesSolutions:
  • Ensure you have Node.js 20.x or higher: node --version
  • Delete node_modules folder and package-lock.json, then run npm install again
  • Check that TypeScript is properly installed: npx tsc --version
  • Review the terminal output for specific error messages
Symptoms: Error when installing from .vsix fileSolutions:
  • Verify the .vsix file is not corrupted (re-download if necessary)
  • Check file permissions - ensure VS Code can read the file
  • Try installing via command line: code --install-extension path/to/extension.vsix
  • Ensure no other version of the extension is already installed (uninstall it first)

​
Uninstalling

If you need to uninstall DotNET Build Buddy:
1

Open Extensions View

Press Ctrl+Shift+X (Windows/Linux) or Cmd+Shift+X (macOS)
2

Find the Extension

Search for “DotNET Build Buddy” or find it in your installed extensions list
3

Uninstall

Click the gear icon next to the extension and select “Uninstall”
4

Reload VS Code

Click “Reload” when prompted to complete the uninstallation
Uninstalling the extension does not delete any project files or solution files it created. Those files remain in your workspace.

​
Next Steps

Now that you have DotNET Build Buddy installed, head over to the Quick Start guide to see it in action.

Build docs developers (and LLMs) love

Get started for freeTalk to us