Skip to main content

Epistemic Calculus CLI — measure and improve your knowledge vault health

Project description

vault-health

CI

Epistemic Calculus CLI — measure and improve your knowledge vault health.

Built as a Tracer Bullet from 4 software engineering books.

Installation

pip install vault-health

Usage

# Scan a vault and see health report
vh --path ~/my-obsidian-vault/

# JSON output for piping
vh --path ~/my-obsidian-vault/ --json

Architecture

src/vault_health/
├── cli/         # CLI commands (Typer)
├── engine/      # 7 epistemic operators (pure Python)
├── core/        # Vault scanner, graph builder
└── output/      # Formatters (terminal, JSON)

Operators

Operator Metric Target
🟢 δ Depth (avg words/file) >60% deep
🔵 κ Connectivity (links/file) >5 avg
🟡 ρ Recency (updated files) <30d
🔴 β Broken link ratio <1%
🟣 λ Orphan ratio <1%
🟠 ω Width (breadth/depth balance) >40%
⚪ φ Coherence (bridge quality) >0.8

Development

uv sync --dev
uv run pytest
vh --path ~/my-vault/

Built on principles from:

  • The Pragmatic Programmer — DRY, Tracer Bullets, Decoupling
  • A Philosophy of Software Design — Deep modules, Info hiding
  • Software Engineering at Google — Code review, Testing, CI/CD
  • Software Architecture: The Hard Parts — ADR, Trade-off analysis

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vault_health-0.1.0.tar.gz (43.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vault_health-0.1.0-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

Details for the file vault_health-0.1.0.tar.gz.

File metadata

  • Download URL: vault_health-0.1.0.tar.gz
  • Upload date:
  • Size: 43.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for vault_health-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f30b850a85053a1ed25f8fdf29aa7a1182b25ff317ff87e9e9bc8fe751278199
MD5 180f3e416d11146a8a72aab3a4cf1634
BLAKE2b-256 4ea6aaf09f1a72436b3291b5b60a7cb73415eae29e845232928b620fefcf74c6

See more details on using hashes here.

File details

Details for the file vault_health-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: vault_health-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 17.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for vault_health-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4be9e028cfdfb8eb951d23023e0064b8275314690360aff43cb7b941589cd395
MD5 b11c720100ba51fbf2f9d9bc91605e55
BLAKE2b-256 99e13d25c4356c7274bca8aeb2edaed3e60d0aa15e1fd6503e9f12329d80f6f7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page