Inspect
What it does
Section titled “What it does”hyodo inspect <path> walks a directory the way a field-deployment
engineer would — a documents folder, a repository, or any subtree — and
produces an inventory whose analysis is complete by definition: every file
is either digested, or explicitly listed under unreadable. It writes
.hyodo/folder-manifest.json (whole-file digests) and
.hyodo/chunks-manifest.json (fixed 4096-byte chunk ranges). It is
read-only and never calls evaluate_policy — absorbing a directory you
explicitly pointed HyoDo at is not an external variable.
hyodo inspect docs --ignore "*.png"What is stored
Section titled “What is stored”- A 12-hex-char content digest, size, and mtime per file.
- Byte ranges and chunk digests in
chunks-manifest.json— never chunk text. - An
unreadableentry (with a reason) for anything that could not be digested, including symlinks that escape the root. - A
--remote-inventoryclaim, copied verbatim underremote:— a connector’s own declaration, never verified by fetching.
What is never stored
Section titled “What is never stored”- File contents, chunk text, or embeddings of any kind — chunking a file is not the same as vectorizing it; HyoDo emits ids, digests, and byte ranges only.
- A file with a
secret-category finding fromhyodo safe’s scanner: it is digested (still “observed”) but excluded from chunking and reported by digest and location only, never by value. - A percentage.
coverageis always printed as<observed>/<expected> files digested, an integer count.
Exit codes
Section titled “Exit codes”| Outcome | Exit |
|---|---|
| Manifests written, coverage complete | 0 |
<path> missing/not a directory, or malformed --remote-inventory |
1 |
Manifest write failed (OSError) |
2 |
There is no ASK/exit-3 case — hyodo inspect never calls
evaluate_policy.
Full reference
Section titled “Full reference”docs/INSPECT.md covers the data model, symlink handling, and the remote-inventory schema in full.