Shellui docs

Shellui is an open-source web app development platform - a microfrontend shell that wraps your application with shared navigation, authentication, storage, and administration. This site documents @shellui/cli, @shellui/core, and @shellui/sdk for developers who host an iframe app inside that shell.

Start here

1. Install the CLI - add @shellui/cli globally or in a project
2. Create a project - run shellui init, start the dev server, and build
3. Framework starters - per-framework companions, ports, theme, and i18n
4. Connect a backend - Shellui identity-service, Supabase Auth, or no backend
5. Configure authentication - /login, sessions, and requiresAuth
6. Configure navigation - sidebar items, groups, and iframe URLs
7. Use the SDK - toasts, overlays, storage, and settings from the iframe

Canonical docs live at docs.shellui.com. Try a running shell on playground.shellui.com. Source is on GitHub.

Features

Navigation and layout

• Navigation - icons, groups, locales, opening modes, and route guards
• Layouts - sidebar, inset, fullscreen, app bar, floating, and windows
• Modals and drawers - overlays for nav targets and SDK calls

Appearance

• Themes - light and dark tokens, curated palettes, and themesDir
• Internationalization - en / fr labels and Settings language

Shell UI

• Toasts - host toasts from @shellui/sdk
• Dialogs - confirm and alert dialogs in host chrome
• Floating chrome actions - back / title / trailing / primary FAB via the SDK

Platform

• Administration - staff admin iframe and custom sidebar links
• Storage - storage-service quota and shellui.storage
• Storage picker - selectFolders / selectFiles
• Application settings - per-app panels in Settings
• Cookie consent - cookie registry and feature gating
• Legal documents - privacy and terms from markdown
• Service worker - opt-in caching and update prompts

Packages

• CLI - commands, config files, env substitution, and shellui deploy
• Core - React runtime, config types, and useAuth
• SDK - iframe APIs, including the CDN tiny script
• Desktop app - shellui dev --app and Tauri 2 bundles

Contribute and operate

• Development - build this monorepo
• Publishing - npm tags and version sync
• Sentry - production error reporting
• ADR 0001 - agent skill hosting and token budget
• Playground source - one package where pnpm start runs the shell plus a Vite iframe app

Official agent skills live in shellui/skills. Install with npx skills add shellui/skills --skill shellui.