Wizzlethorpe Vaults

🌐 Documentation and live demo: vaults.wizzlethorpe.com

Self-host an Obsidian vault as a static, role-gated wiki on your own Cloudflare account, with optional sync into Foundry VTT.

This is the monorepo for three intertwined pieces. They release in lockstep so a "vaults vX.Y.Z" tag pins the exact behavior across all three:

• cli/: @wizzlethorpe/vaults (npm). The renderer + deploy CLI. Reads your vault, renders to HTML, deploys to a Cloudflare Pages project on your own account.
• foundry/: Wizzlethorpe Vaults Foundry VTT module. Pulls a deployed vault into a Foundry world as journal entries, with optional Actor / Item / Scene / RollTable / etc. creation from a per-page foundry: block.
• landing/: A vault that doubles as the project's landing page (deployed at vaults.wizzlethorpe.com) and a working demo of every CLI feature.

Getting started

# CLI
npm install -g @wizzlethorpe/vaults
vaults init my-vault && cd my-vault
vaults preview        # local preview
vaults push           # deploy to your Cloudflare account

Foundry module: install via the Foundry package directory (search "Wizzlethorpe Vaults") or use the manifest URL https://github.com/wizzlethorpe/vaults/releases/latest/download/module.json.

Versioning

A single shared version applies across all three subprojects. The root release.sh <X.Y.Z> bumps cli/package.json, foundry/module.json, tags v<X.Y.Z>, and runs each subproject's release pipeline (npm publish, Foundry GitHub release + CDN upload, landing deploy).

Repo layout

.
├── cli/               # TypeScript CLI + Cloudflare Pages template (publishes to npm)
├── foundry/           # Foundry VTT module (publishes to Foundry package directory + CDN)
├── landing/           # Demo vault, deployed at vaults.wizzlethorpe.com
├── package.json       # Workspace manifest (cli + foundry)
├── pnpm-workspace.yaml
└── release.sh         # Single-command unified release

Support

Wizzlethorpe Vaults is a free and open-source Wizzlethorpe Labs product. If you find it useful, please consider supporting us on Patreon. Check out wizzlethorpe.com for more free tools and content!

Contributing

See CONTRIBUTING.md for the full guide. Short version: working on a single subproject is normal (cd cli && pnpm typecheck && pnpm test, etc.); cross-cutting PRs touching CLI + Foundry + landing together are welcome. Contributions are governed by the Contributor License Agreement.

License

MIT. See LICENSE.