Documentation

Specifications, designs, and operator guides. Specs are published before the matching UI ships. The Swift engine stays on your Mac.

Burrow™

Burrow™ is a local-first macOS storage management machine. It inventories files across internal disks, iCloud Drive, OneDrive, and removable volumes so you can answer:

  1. What files do I have?
  2. Where are they stored?
  3. What is duplicated, stale, or suitable for archival?
  4. Are important files actually protected by verified backups?

The public site at burrow.jasonkoch.io is documentation only (/docs). Inventory runs in the Burrow™ Mac app. See ADR-004.

The engine is local Burrow™ does not grant remote filesystem access. The website cannot call 127.0.0.1. Run the Mac app on this computer for scans. See Architecture.

Current scope

The initial release is read-only. Phase 1 may scan and catalog; it must not move, rename, delete, archive, or back up user files.

Safety Level 0 remains in effect until VLT-38 is owner-reviewed.

Run the app locally

make lint
make typecheck
make test
make build

cd apps/web && npm install && npm run dev
cd engine/Burrow && swift run Burrow

Local docs are typically http://localhost:3000. The engine binds 127.0.0.1:8741 and exposes GET /health and GET /identity behind X-Burrow-Secret (legacy X-PlatypusVault-Secret is still accepted). The hosted website does not offer a console.

Public site

Environment Hostname
Production burrow.jasonkoch.io
Development burrow-dev.jasonkoch.io

The public website and this portal are the Next.js app. Run cd apps/web && npm run dev and open /docs. Hosting details are in Hosting.

Project

Item Value
Version 0.0.0
Jira VLT — Burrow™
GitHub PlatypusDBA/Burrow