Getting Started

Get up and running with nmbl in just a few minutes.

Prerequisites#

Before you begin, ensure you have:

• .NET 10 SDK or later
• Windows, macOS, or Linux

Installation#

Install nmbl as a global .NET tool:

dotnet tool install --global nmbl

Or update if already installed:

dotnet tool update --global nmbl

Verify Installation#

Check that nmbl is installed correctly:

nmbl --version

Authentication#

nmbl requires authentication to use. You can authenticate using either OAuth or a license key.

Option 1: OAuth Authentication (Recommended)#

Authenticate using your Google account:

nmbl login

This will open a browser window for Google authentication. After successful login, your authentication token is securely stored and will be used for subsequent commands.

Note: Only users with authorized email domains (e.g., @nimblepros.com) can authenticate via OAuth.

Option 2: License Key#

If you have a license key, you can provide it using one of these methods:

Command line argument:

nmbl --license-key YOUR_LICENSE_KEY <command>
nmbl -l YOUR_LICENSE_KEY <command>

Environment variable:

# Windows PowerShell
$env:NMBL_LICENSE_KEY = "YOUR_LICENSE_KEY"

# Windows Command Prompt
set NMBL_LICENSE_KEY=YOUR_LICENSE_KEY

# Linux/macOS
export NMBL_LICENSE_KEY=YOUR_LICENSE_KEY

Configuration file:

Create a file at:

• Windows: %APPDATA%\nmbl\config.json
• Linux/macOS: ~/.config/nmbl/config.json

{
  "licenseKey": "YOUR_LICENSE_KEY"
}

First Steps#

Once authenticated, try these commands:

View Available Commands#

nmbl help

For detailed examples:

nmbl help --with-examples

Analyze a Project#

Calculate cyclomatic complexity:

nmbl cc YourProject.csproj

Generate a dependency graph:

nmbl deps YourSolution.slnx

Count lines of code:

nmbl loc YourProject.csproj

Next Steps#

• Commands Reference - Learn about all available commands
• Authentication Guide - Detailed authentication setup