Skip to content
Dirwell

Getting started

With Node.js 22.12 or later and an existing folder:

Terminal window
npx @dirwell/cli server ./downloads

Open the printed URL. The server binds to loopback on an available port. Refreshing or navigating reads current files. Ctrl+C stops the server. No project, configuration or separate theme install is required.

Publish a static folder

Section titled “Publish a static folder”
Terminal window
npx @dirwell/cli build ./downloads --out ./site-downloads

Upload the entire output tree to a static host. Build replaces this dedicated directory; keep unrelated files elsewhere. Selected source files are copied by default. Existing source index.html and index.htm files are preserved; the explorer uses _dirwell.html when available.

Plain is the default and has no search runtime, fonts, icons or generated share image. For a searchable interface:

Terminal window
npm install --save-dev @dirwell/cli @dirwell/theme-ledger
npx dirwell server ./downloads --theme ledger --live

--live refreshes rich-client data automatically. Ledger and Crosswave are separate optional installs. Configuration explains custom themes, file selection and build settings. Deployment explains URL prefixes and HTTP hosting.