Skip to content

Latest commit

 

History

History

ShellUI.Native.CLI

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

ShellUI Native

ShellUI Native CLI

Command-line interface for ShellUI Native: shadcn-style, copy-and-own components for .NET MAUI and Avalonia, with the same design tokens as ShellUI for Blazor.

Installation

dotnet tool install -g ShellUI.Native.CLI --prerelease

Requires the .NET 10 SDK.

Commands

shellui-native init [--yes] [--force]     # Initialize project
shellui-native add <components>           # Add components
shellui-native list [--installed]         # List components
shellui-native remove <components>        # Remove components
shellui-native update [--all]             # Update components

Quick Start

# Navigate to your MAUI or Avalonia project
cd YourProject

# Initialize ShellUI Native
shellui-native init --yes

# Add components
shellui-native add button input card

Components are written to Components/UI/ as plain C# files you own (Components/Native/ in a project that also uses ShellUI for Blazor). init detects whether the project is MAUI or Avalonia and installs that platform's version of each component.

Blocks are ready-made screens built from components, numbered like ShellUI's dashboard-01: shellui-native add bottom-nav-01 writes Components/Blocks/BottomNav01.cs and installs the components it uses. Available: bottom-nav-01 to bottom-nav-05 (app shells with a bottom tab bar) and edge-menu-01 (a page with a tool dock on its edge).

More Information

The Shell family

Project
ShellUI The Blazor component library this one mirrors
ShellIcons Lucide icons for Blazor, MAUI and Avalonia
ShellDocs The docs framework behind the ShellUI sites