README file from
GithubViggVault
Read-only Obsidian plugin for opt-in Work link style, current-note Wiki layout and Activity text checks, powered by the ViggObsidian Rust engine.
ViggVault is the user-facing product; ViggObsidian remains the shared engine, package source and native CLI. Both are maintained, with one upstream rule implementation. See the product/engine boundary.
Work link style
Enable Work link-style rules in ViggVault settings. The rules are off by default because direct wikilinks, source labels and Wiki metadata conventions may differ from your vault. No personal vault paths or configuration are required.
Run Check current note link style, Check current folder link style (includes subfolders), or Check vault link style from the command palette. The findings view shows scope, completion status, path, line, rule and suggested presentation. Click a finding to navigate. Cancel check stops capture/evaluation. Nothing applies suggestions or edits notes.
All Work scopes read the full visible Markdown inventory for resolution, including note titles. Hidden paths are excluded; 90-templates is skipped. Only selected targets are checked. Snapshot changes, limits, cancellation and errors show Incomplete. A completed Work check covers only this link-style rule set, not full ViggObsidian validation. Results are a snapshot; rerun after edits.
Wiki layout
Select Wiki profile → Numbered-v1 · Wiki in settings, then run Check current note Wiki layout. The shared Rust selector accepts wiki.md beneath any relative wiki folder component, including nested folders, or a note with cssclasses: [vault-wiki-direct]. Ordinary notes, including notes with only layer: wiki, and unsupported profiles are not applicable. A selected Wiki target without frontmatter is Incomplete.
Only the current note is read. The text rules check the preamble, facts, table of contents, heading anchors and source-inventory tables. Findings retain upstream rule IDs and messages and open the note without fabricated line numbers or severity. Errors, timeouts, cancellation and snapshot changes remain Incomplete. The check does not verify real source files, shortcut destinations or folder targets and is not full ViggObsidian validation. No notes are changed.
The Wiki engine has separate source and WASM pins. Portable v2 capture leaves selection, body normalization and recognized knowledge-owner notice preprocessing in shared Rust. Obsidian supplies frontmatter boundaries and YAML parsing from the same captured text; this does not claim full native YAML or filesystem eligibility parity. The existing Work engine has its own unchanged pin.
Activity text
Select Activity profile → Numbered-v1 · Activity, then run Check current note Activity text. Only the current note is read. Shared Rust checks activity_format: chat-v1, activity_contract: provenance-v1, the Activity tail selected by cssclasses: [vault-event-v1-1], marked mail drafts/deliveries and canonical human-input markers. Marker-free historical notes are not applicable; legacy stamps and headers remain supported. Unknown contracts produce a finding. The selected profile requires frontmatter; missing or malformed capture is Incomplete.
Findings retain upstream rule IDs/messages and open the note. Formal author/provenance markers do not verify real identity or completed actions. Event headers, dossier paths, shortcut targets, native Raw classification and source files remain outside this text slice. Errors, changed snapshots, cancellation, timeouts and limits are Incomplete. No text or provenance is changed.
The separately pinned Activity source and WASM reuse unchanged Work helpers. Obsidian supplies YAML boundaries and parsing; the mapping protocol does not claim native YAML-parser parity. This command is off by default and does not adopt local provider or identity configuration.
Capabilities and compatibility
Run Show capabilities and compatibility from the command palette, or use the matching control in settings. It opens a separate, read-only panel: it does not capture vault content, start a Worker, inspect a native connection, change settings, cancel an active check or replace findings.
The panel reports the actual current opt-ins and only the shipped scopes: Work supports current note, current folder (including subfolders) and vault; Wiki and Activity support the current note only. It displays the three independently pinned embedded source revisions, request/result protocol identities and actual embedded WASM SHA-256 digests. These pins are not a single current native-engine version. Native-only filesystem/package capabilities are unavailable, and no native connection is inspected.
The panel accepts only the reviewed vendor/product-capabilities.v1.json declaration whose SHA-256 and pinned private-review revision are verified by vendor/product-capabilities-provenance.json. Its joint label is Pinned declarations verified, native connection not inspected: it is not a native-engine version, connection inspection, release claim or broad compatibility guarantee. Native-only and unshipped-proof entries remain explicitly unavailable in the plugin. The upstream execution contract remains the product/engine boundary.
Privacy and installation
Processing stays in a local browser Worker with embedded Rust/WASM engines. No network, telemetry, external files, subprocesses, helper installation or downloader. Explicit rule/profile selections are saved through Obsidian's plugin settings API. No automatic scanning.
Install ViggVault from Obsidian's Community plugins catalog and enable it. See the Community listing.
For manual installation, download main.js, manifest.json and styles.css from the latest stable release, place them in <vault>/.obsidian/plugins/vigg-vault/, then enable ViggVault. Preserve any existing data.json. macOS arm64 Obsidian desktop 1.15.0 is the verified host; mobile and other app platforms are unverified.
Build and check
Production bundling requires Node and npm only. All three pinned WASM assets are committed with their digests, source files, lockfiles and canonical build provenance; no Rust compiler or network fetch is needed during bundling after npm ci. Host and release verification is recorded per version; earlier Linux evidence belongs to 0.1.1.
npm ci
npm run build
To verify the engines from source, use Rust 1.92.0 and its wasm32-unknown-unknown target (rust-toolchain.toml):
npm run build:wasm
npm run build:wiki-wasm
npm run build:activity-wasm
npm run check:wasm
cargo build --locked --manifest-path vendor/link-style-core/Cargo.toml --target-dir build/rust
cargo build --locked --manifest-path vendor/wiki-layout-core/Cargo.toml --target-dir build/wiki-rust
cargo build --locked --manifest-path vendor/activity-core/Cargo.toml --target-dir build/activity-rust
npm run check
npm run check:privacy
For additional native Rust checks, run cargo test, cargo fmt -- --check and cargo clippy --all-targets -- -D warnings against each vendored crate's manifest, preserving its lockfile and using the corresponding target directory.
build:wasm, build:wiki-wasm and build:activity-wasm write only to their respective build directories and never overwrite pinned assets. check:wasm compares all three outputs byte-for-byte with the committed assets on the canonical macOS arm64 toolchain. The earlier Work engine investigation found different raw WASM bytes from Linux x86_64 with the same Rust version; no cross-host Rust byte-identity is claimed. Native/WASM behavior is checked separately. Production npm run build embeds the exact committed assets without recompiling Rust.
The Rust launchers remap HOME, Cargo cache and checkout roots to generic /build/ paths through rustc's --remap-path-prefix, use Cargo's encoded flags and retain the 256 MiB memory limit. check:privacy verifies asset and source digests, checks the raw assets and actual decoded bundle payloads, and requires them to match. See the Work WASM provenance and Wiki WASM provenance.
Actual-host proofs require explicit absolute VIGGVAULT_TEST_ROOT (the designated obsidian-test-vault), VIGGVAULT_PRIVATE_TMP (a private .tmp directory) and VIGGVAULT_HOST_EVIDENCE (a child of that directory). Run node tests/host-proof.mjs for Work/Wiki, or node tests/activity-host-proof.mjs for Activity, using a separate evidence directory per proof. These CLI scripts switch notes and open settings in the selected test window. Run them only in a proven isolated test window or after agreeing to that visible interaction. CLI use alone does not isolate the UI. They restore settings, the active note and fixtures; never target a personal vault. Routine native/WASM and platform tests run headlessly.
Architecture and limits, Work source provenance, 0.3.0 verification, 0.3.0 publication, retained 0.2.0 verification, retained 0.1.1 verification.
MIT. Rust engines by Viggo Meesters are vendored unchanged from ViggObsidian at their recorded revisions; the MIT license is retained in vendor/LICENSE. Rust dependency notices are recorded in THIRD-PARTY-NOTICES.md. TypeScript, Obsidian typings, esbuild and lint tools are development-only and are not bundled as runtime libraries.