Installation
Install ShellUI via CLI or NuGet package
ShellUI 0.3 offers a hybrid workflow with two installation methods. Choose the approach that fits your project.
The current stable release is 0.4.0, which the v0.4 docs cover. To install 0.3, name the version: --version 0.3.6, as in the commands on these pages.
Prerequisites
- .NET 10 SDK to run the CLI; your Blazor project can target .NET 8, 9 or 10 with the CLI, or .NET 10 with the NuGet package
- 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?
| Aspect | CLI Tool | NuGet Package |
|---|---|---|
| Install command | shellui add button card |
dotnet add package ShellUI.Components --version 0.3.6 |
| Components | Source copied to your project | Pre-compiled, referenced as package |
| Customization | Full source code access — edit anything | Override via CSS, limited code changes |
| Tailwind setup | Automatic via shellui init |
Manual setup required |
| Bundle size | Only components you add | All components included |
| Updates | Re-run shellui add per component |
Bump package version |
| Best for | Production apps, full customization | Prototyping, 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 --version 0.3.6
# 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 Blazor'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:
- Build your project:
dotnet build - Check that
wwwroot/app.csswas generated - 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
- GitHub Issues — Report bugs or request features
- Documentation — Full ShellUI docs
- Community Discussions — Ask questions