ShellDocs.CLI 0.1.19-alpha

This is a prerelease version of ShellDocs.CLI.
dotnet tool install --global ShellDocs.CLI --version 0.1.19-alpha
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local ShellDocs.CLI --version 0.1.19-alpha
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=ShellDocs.CLI&version=0.1.19-alpha&prerelease
                    
nuke :add-package ShellDocs.CLI --version 0.1.19-alpha
                    

ShellDocs

ShellDocs CLI

shelldocs scaffolds, runs and exports ShellDocs sites: Markdown-driven documentation for .NET with live Blazor component previews, versioned docs, Cmd+K search and a static export.

Install

The tool needs the .NET 10 runtime:

dotnet tool install --global ShellDocs.CLI --prerelease

Quick start

# From your repo root: scaffold a Blazor Web App in docs/<RepoFolder>.Docs
shelldocs init
cd docs/<RepoFolder>.Docs

# Add pages (or drop .md files into content/docs/)
shelldocs add component Button
shelldocs add guide getting-started

# Run with hot reload on http://localhost:5000
shelldocs dev

# Prerender a static site into publish/, then serve it as a static host would
shelldocs build
shelldocs preview

Already have a Blazor project? Run shelldocs init --attach inside it: it adds the packages and content, and writes SHELLDOCS_SETUP.md with the Program.cs / App.razor snippets instead of editing your code.

Commands

Command What it does
shelldocs init Scaffolds a docs site, or adds ShellDocs to an existing Blazor project with --attach
shelldocs add Adds a page from a template (component, guide, …)
shelldocs dev Runs the site with hot reload
shelldocs build Prerenders every page to static HTML for GitHub Pages, Cloudflare Pages, Netlify or S3. --base-href for a sub-path, --site-url for sitemap, robots and og: meta
shelldocs preview Serves the export on http://localhost:5050 as a static host would, to check it before deploying

Alpha: APIs may change between minor versions. MIT licensed.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated
0.1.19-alpha 90 10/21/2026
0.1.18-alpha 75 10/20/2026
0.1.17-alpha 69 10/14/2026
0.1.16-alpha 55 10/14/2026
0.1.15-alpha 70 10/11/2026
0.1.14-alpha 77 10/10/2026
0.1.13-alpha 64 10/10/2026
0.1.12-alpha 67 10/4/2026
0.1.11-alpha 68 10/3/2026
0.1.10-alpha 77 10/2/2026
0.1.9-alpha 68 10/2/2026
0.1.8-alpha 77 10/2/2026
0.1.7-alpha 127 9/7/2026
0.1.6-alpha 88 8/29/2026
0.1.5-alpha 88 8/29/2026
0.1.3-alpha 108 8/11/2026
0.1.2-alpha 102 7/28/2026
0.1.1-alpha 98 7/25/2026
0.1.0-alpha 124 7/25/2026