Zero config
A portable SSG build with relative URLs. Copy it anywhere and open it.
SSG · relative URLsPut a directory
on the web.
Dirwell builds a static file explorer with search, keyboard navigation, safe symlinks, and a theme API. Run one command. Deploy the output anywhere.
$ pnpm dlx dirwell .
Dirwell is watching /releases
Local: http://localhost:4173Default theme · generated from the file-icons previewOpen full explorer
The folder already has the information.
Most directory listings lose the context people need, or turn a small publishing job into an application. Dirwell keeps the filesystem legible and the output static.
- Start
- No config file required.
- Inspect
- Full metadata and explicit symlink states.
- Ship
- Plain files for any static host.
- Adapt
- Replace components or the renderer.
Five examples. Same directory model.
Open the generated site, then inspect the exact source that produced it.
Base URL
An MPA build mounted below a base path with one shared runtime.
MPA · base URLsRelease catalog
Build a complete listing with its own HTML and CSS from the prepared directory data.
custom theme · no JavaScriptCustomize the default theme
Catppuccin Latte and Macchiato colors and icons with a changed header.
component overrides · theme iconsPlain HTML
A directory listing with native links, no icons, and no client-side code.
plain HTML · no JavaScriptUseful before you configure it.
Serve the current folder while you work. Build the same folder when it is ready.
Preview and watch
pnpm dlx dirwell .Build static output
pnpm dlx dirwell build . -o distThe defaults are an entry point, not a ceiling.
Keep the built-in interface, replace one typed component, or own every byte of the document. URL generation and output naming are separate decisions.
createDefaultTheme({
components: {
EntryRow: ReleaseRow,
},
})defineConfig({
base: "/dirwell/",
urls: "base",
mode: "mpa",
})outputName(directory) {
return hasIndex(directory)
? null
: "index.html";
}A directory can be the product.
Keep it static. Make it navigable. Change only what your project needs.
Get started