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 Installation (Recommended)
Copy components directly into your project for full ownership and customization. Automatic Tailwind setup, MSBuild integration, and component management.
NuGet Package
Traditional package install for quick prototyping. Pre-compiled components with manual Tailwind CSS setup.
CLI vs NuGet — Which to Choose?
| Aspect | CLI Tool | NuGet Package |
|---|---|---|
| Install command | shellui add button card | dotnet add package ShellUI.Components |
| 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
# 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 runThat'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 rundotnet new blazorwasm -n MyApp
cd MyApp
shellui init
shellui add button card input
dotnet runWorks with MAUI, WPF, and WinForms Blazor Hybrid apps.
dotnet new maui-blazor -n MyApp
cd MyApp
shellui init
shellui add button card input
dotnet runSupports .NET 9's Interactive Server rendering mode.
dotnet new blazor -n MyApp
cd MyApp
shellui init
shellui add button card input
dotnet runVerification
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