Quickstart

1. Pick how you want to run it#

To run the prebuilt container, create a data folder and start BladeVault:

mkdir -p "$HOME/BladeVault/data"

docker run -d \
  --name bladevault \
  --restart unless-stopped \
  -p 5500:3000 \
  -v "$HOME/BladeVault/data:/app/data" \
  ghcr.io/dedkola/bladevault:latest

Open http://localhost:5500.

2. Add your first knives#

• Import from a URL — paste a retailer's product URL and review the imported details. If the page requires interaction, use the interactive browser fallback. See Add a knife from a product URL.
• Import a list — paste several links and let Batch scrape work through them one at a time. See Add several knives at once.
• Enter it manually — add specifications, a price, notes, a source link, and local photos yourself. See Add a knife manually.

3. Make the collection yours#

• Add custom fields for text, numbers, and dates, and choose which details appear on cards and in the pinned sidebar.
• Save search and filters as a Smart Collection that updates as your records change.
• Browse variants in Model families, or search and filter to find a specific knife.
• Use bulk actions to edit or pin several records at once.

See Organize your collection for an overview.

4. Compare, maintain, understand#

• Compare — build named shortlists, show only the differences, export to PDF. See Compare knives.
• Maintain — log cleaning, lubrication, sharpening, stropping, and disassembly with dated notes. Review changes and care history in Logs.
• Insights — explore makers, materials, dimensions, completeness, and activity. See Collection insights.
• Improve records — find missing fields, review measurements, and standardize labels. See Improve collection data quality.

5. Protect the data#

BladeVault is local-first: the vault is a SQLite database plus local images in a folder you choose.

• Where it lives — ~/BladeVault/data by default for the desktop app and source runs, /app/data inside a container. See Your data.
• App lock — an optional password on the local vault (off by default). See App lock.
• Backups — download a portable full-vault ZIP or enable optional cloud backup. See Back up and restore your vault.

Next steps#

• Connect an AI client to your collection with MCP.
• Running from a checkout? Run from source lists every command, including the test suites.
• Want to contribute? See the contributing guide.