Table of Contents

Getting Started

Prerequisites

Before installing Velocity, you'll need:

  • .NET 10 SDK or later (download here)
  • YndigoBlue subscription with access credentials for the private NuGet feed
  • A supported IDE or text editor (Visual Studio, Visual Studio Code, or any editor for command-line development)

Obtaining Access

Velocity is distributed through a private YndigoBlue NuGet feed. To access the packages, you must first subscribe and obtain your credentials. Contact YndigoBlue to set up your subscription and receive your NuGet feed authentication details.

Configuring the NuGet Feed

Once you have your credentials, you'll need to configure your development environment to access the YndigoBlue NuGet feed at:

https://www.yndigoblue.com/nuget/v3/index.json

Choose the setup method that matches your development environment:

Visual Studio

  1. Open Visual Studio
  2. Go to Tools > Options
  3. Navigate to NuGet Package Manager > Package Sources
  4. Click the + button to add a new source
  5. Set the following values:
    • Name: YndigoBlue
    • Source: https://www.yndigoblue.com/nuget/v3/index.json
  6. Click Update, then OK
  7. Go to Tools > NuGet Package Manager > Package Manager Settings
  8. Navigate to NuGet Package Manager > Package Source Credentials
  9. Click + to add credentials for the YndigoBlue source
  10. Enter your username and password provided by YndigoBlue

Installing Velocity in a project:

  1. Right-click on your project in Solution Explorer
  2. Select Manage NuGet Packages
  3. Select YndigoBlue from the package source dropdown
  4. Search for YndigoBlue.Velocity (or a platform-specific variant)
  5. Click Install

Visual Studio Code

Visual Studio Code uses the .NET CLI for NuGet operations. Follow the command-line setup below, then use the terminal in VS Code to manage packages.

For a better experience, install the NuGet Package Manager extension:

  1. Open VS Code
  2. Go to Extensions (Ctrl+Shift+X)
  3. Search for "NuGet Package Manager"
  4. Install the extension by jmrog

After configuring the NuGet source via command line (see below), you can:

  • Press Ctrl+Shift+P (Cmd+Shift+P on macOS)
  • Type "NuGet: Add Package"
  • Search for and install Velocity

Command Line (.NET CLI)

Add the NuGet source:

dotnet nuget add source https://www.yndigoblue.com/nuget/v3/index.json \
  --name YndigoBlue \
  --username YOUR_USERNAME \
  --password YOUR_PASSWORD \
  --store-password-in-clear-text

Security Note: The --store-password-in-clear-text flag stores credentials in plain text. For better security, consider using --configfile to specify a user-specific NuGet.config file with appropriate permissions, or omit the password flag to be prompted interactively.

Alternative: Interactive authentication:

dotnet nuget add source https://www.yndigoblue.com/nuget/v3/index.json \
  --name YndigoBlue \
  --username YOUR_USERNAME

You'll be prompted for the password when accessing packages.

Installing Velocity in a project:

Navigate to your project directory and run:

dotnet add package YndigoBlue.Velocity

Or to specify a particular version:

dotnet add package YndigoBlue.Velocity --version 2025.1.0

For platform-specific packages with DB2 and SQLite support, use:

dotnet add package YndigoBlue.Velocity.Windows
dotnet add package YndigoBlue.Velocity.Linux
dotnet add package YndigoBlue.Velocity.MacOS
dotnet add package YndigoBlue.Velocity.RaspberryPi

Verifying the installation:

dotnet list package

You should see Velocity listed in your project dependencies.

Choosing the Right Package

Velocity offers multiple package versions to accommodate different platform and database requirements:

YndigoBlue.Velocity (Standard)

Use this version if you:

  • Do NOT need IBM DB2 or SQLite support
  • Want maximum platform compatibility without build complexities
  • Are using MySQL, Oracle, PostgreSQL, SQL Server, or Teradata only
dotnet add package YndigoBlue.Velocity

Platform-Specific Packages

If you need DB2 and/or SQLite support, choose the platform-specific package for your target OS:

  • YndigoBlue.Velocity.Windows - x64 architecture, includes DB2 and SQLite
  • YndigoBlue.Velocity.Linux - x64 architecture, includes DB2 and SQLite
  • YndigoBlue.Velocity.MacOS - Arm64 architecture, includes DB2 and SQLite
  • YndigoBlue.Velocity.RaspberryPi - Arm64 architecture, includes SQLite (no DB2)
dotnet add package YndigoBlue.Velocity.Windows

Note: Platform-specific packages require targeting x64 (Windows/Linux) or Arm64 (macOS/Raspberry Pi) when compiling. See Version Selection for detailed guidance on package selection and multi-platform build strategies.

Troubleshooting

Cannot authenticate to NuGet feed:

  • Verify your credentials are correct
  • Ensure your subscription is active
  • Check that the NuGet source URL is exactly: https://www.yndigoblue.com/nuget/v3/index.json

Package not found:

  • Confirm the YndigoBlue source is listed: dotnet nuget list source
  • Try clearing the NuGet cache: dotnet nuget locals all --clear
  • Verify you're searching in the YndigoBlue source, not just nuget.org

Platform-specific errors:

  • Ensure you're using the correct platform package for your target OS
  • Verify .NET 10 SDK is installed: dotnet --version