ShellUI Logo
ShellUI

Installation

Install ShellUI via CLI or NuGet package

ShellUI v0.2.0 offers a hybrid workflow with two installation methods. Choose the approach that fits your project.

Prerequisites

  • .NET 8.0 or higher
  • Node.js (optional — only needed if using npm for Tailwind)
  • A Blazor project (Server, WebAssembly, Hybrid, or Interactive Server)

Installation Methods


CLI vs NuGet — Which to Choose?

AspectCLI ToolNuGet Package
Install commandshellui add button carddotnet add package ShellUI.Components
ComponentsSource copied to your projectPre-compiled, referenced as package
CustomizationFull source code access — edit anythingOverride via CSS, limited code changes
Tailwind setupAutomatic via shellui initManual setup required
Bundle sizeOnly components you addAll components included
UpdatesRe-run shellui add per componentBump package version
Best forProduction apps, full customizationPrototyping, quick starts

Tip: You can use both approaches together. Use NuGet for standard components and CLI for ones you need to customize.


Quick Start

The fastest way to get started with ShellUI:

# 1. Install the CLI tool
dotnet tool install -g ShellUI.CLI

# 2. Initialize in your Blazor project
cd your-blazor-project
shellui init

# 3. Add components
shellui add button input card dialog

# 4. Run your app
dotnet run

That's it — shellui init handles Tailwind CSS setup, Bootstrap cleanup, folder creation, and MSBuild integration automatically.

View full CLI guide | View full NuGet guide


Project Types

ShellUI works with all Blazor hosting models:

dotnet new blazorserver -n MyApp
cd MyApp
shellui init
shellui add button card input
dotnet run
dotnet new blazorwasm -n MyApp
cd MyApp
shellui init
shellui add button card input
dotnet run

Works with MAUI, WPF, and WinForms Blazor Hybrid apps.

dotnet new maui-blazor -n MyApp
cd MyApp
shellui init
shellui add button card input
dotnet run

Supports .NET 9's Interactive Server rendering mode.

dotnet new blazor -n MyApp
cd MyApp
shellui init
shellui add button card input
dotnet run

Verification

After installation, verify everything is working:

  1. Build your project: dotnet build
  2. Check that wwwroot/app.css was generated
  3. Run the project: dotnet run

Quick Test

@page "/test"
@using YourProject.Components.UI

<div class="p-8 space-y-4">
  <Button>Click Me</Button>
  <Button Variant="ButtonVariant.Outline">Outline</Button>
  <Button Variant="ButtonVariant.Destructive">Delete</Button>
</div>

If the buttons render with proper styling, your installation is successful.


Getting Help

On this page