Turn a folder of downloads, reports, or build artifacts into a searchable website. Dirwell generates the file list, directory navigation, and links to the original files. Publish the output on a static host; visitors do not need a Dirwell server.
Try the live explorer · Get started · Documentation
You need Node.js 22.12 or later, which includes npm. From a terminal, replace
./downloads with a folder that already exists:
npx @vp-tw/dirwell serve ./downloadsAccept npm's installation prompt on first use. Open the Local: URL printed by
Dirwell. Add or change a file to see the list update. Press Ctrl+C to stop.
No repository clone or config file is required.
npx @vp-tw/dirwell build ./downloads -o ./site-downloadsUpload the complete site-downloads/ directory to a static host. The default
output uses relative links so it can move between URL paths as one tree. The
command replaces that output directory; keep unrelated files elsewhere.
Existing source index.html and index.htm files are preserved, with the
explorer written to _dirwell.html when that name is free.
The default Ledger theme includes search, sorting, file icons, and keyboard navigation. Files open in a new tab; directory navigation stays in the explorer. Default output includes the listing in HTML and remains browsable without JavaScript. Advanced MPA output can use JavaScript for large directory lists.
Install the package when you need a reusable config, a theme, or a build adapter:
npm install --save-dev @vp-tw/dirwellCreate dirwell.config.ts beside your project's package.json:
import { defineConfig } from "@vp-tw/dirwell";
export default defineConfig({
exclude: ["drafts/**"],
});Run npx dirwell build ./downloads -o ./site-downloads. Pass the source folder
explicitly: the CLI defaults to the current directory even if config sets root.
Pin your tested version when you need reproducible builds.
Tests run with Node.js 26. Full regression has passed in Chromium, Firefox, and Playwright WebKit; CI runs Chromium plus a bounded cross-engine suite. Installed-consumer checks cover Node 22.12, 24.1, and 26 on Windows, Linux, and macOS in ARM64/x64 variants: three-theme SSG/MPA output, CLI build/serve and live updates, encoded names, symlinks, and matching fixed-font share images. Primary Vite/Rollup/webpack paths, native macOS Safari navigation, and iPhone/iPad simulators' layout and scripted controls are also exercised. A user-reported Windows/Xbox controller smoke found no major issue; it is not a complete hardware mapping test. Physical iOS and real screen-reader output remain unverified. See the verification record and adapter capabilities.
| Need | Read |
|---|---|
| Publish under a fixed path, such as GitHub Pages | Deployment |
| Select files, change output names, or configure URLs | Configuration |
| Change the interface or use a no-script listing | Themes |
| Set page titles, descriptions, or share images | Page metadata |
| Generate alongside an existing application | Build tool adapters |
| Check supported integrations and limitations | Support policy |
| Call Dirwell from Node.js or write a theme package | API reference · Theme contract |
| Resolve setup, output, or link problems | Troubleshooting |
Build-tool support is selective. Vite, Rollup, and webpack are the primary integrations; the other existing adapters are experimental. Unplugin supplies shared plugin interfaces, not a promise that every tool or website framework has identical behavior. See the support policy before choosing an adapter.
For repository setup, tests, examples, architecture, and release instructions, see Contributing.
Dirwell's code is MIT licensed. Bundled Source fonts and Ledger file icons have separate attribution and license terms in third-party notices.
For dependency audit scope, patched workspace resolutions, and retained development-only findings, see dependency security. Workspace overrides do not rewrite an installed consumer’s existing lockfile.