feat(cli): add ov doctor diagnostic command#851
Open
mvanhorn wants to merge 2 commits intovolcengine:mainfrom
Open
feat(cli): add ov doctor diagnostic command#851mvanhorn wants to merge 2 commits intovolcengine:mainfrom
mvanhorn wants to merge 2 commits intovolcengine:mainfrom
Conversation
Adds a new `ov doctor` command that validates all OpenViking subsystems
and reports actionable diagnostics without requiring a running server.
Checks: config file, Python version, native vector engine (PersistStore),
AGFS, embedding provider, VLM provider, and disk space. Each check is
isolated so one failure doesn't block others, and every failure includes
a specific fix suggestion.
This addresses a real pain point: when the native engine is missing from
a pip wheel (e.g., Python 3.13), the only feedback is 50+ ERROR log
lines with no actionable guidance. `ov doctor` catches this immediately:
Native Engine: FAIL No compatible engine variant
Fix: pip install openviking --upgrade --force-reinstall
Alt: Use vectordb.backend = "volcengine" instead of "local"
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Failed to generate code suggestions for PR |
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds
ov doctor, a local diagnostic command that validates all OpenViking subsystems and reports pass/fail with actionable fix suggestions. Unlikeov health(which requires a running server),ov doctorworks offline and checks prerequisites before the server even starts.Why this matters: After installing OpenViking v0.2.8 via pip on Python 3.13, the native vector engine (PersistStore) was missing from the wheel. The only feedback was 50+ ERROR log lines. Filesystem operations (ls, tree, add_resource) all worked fine, but search and find silently returned nothing.
ov doctorcatches this immediately with a clear fix suggestion.Related issues:
Type of Change
Changes Made
openviking_cli/doctor.pywith 7 isolated checks: config, Python version, native engine, AGFS, embedding, VLM, disk spaceopenviking_cli/rust_cli.pyto interceptdoctoras a Python-native subcommand before exec'ing the Rust binarytests/cli/test_doctor.pyTesting
Screenshots
All checks passing (installed from modified branch, ran
ov doctorvia CLI entry point):Failure state (native engine missing + no VLM API key):
Each failing check shows a specific fix suggestion. Checks are isolated so one failure doesn't block others.
Checklist
Additional Notes
This contribution was developed with AI assistance (Claude Code). The feature was proposed after dogfooding OpenViking locally and discovering the PersistStore gap firsthand.