Skip to content

contextseek doctor — config & connectivity self-check #46

Description

@Teingi

Describe your use case

EN. New users frequently mis-configure the three required pieces (storage
backend, embedding provider, LLM). Add a doctor subcommand that loads
ContextSeekSettings (src/contextseek/config/settings.py), reports which
backend/embedder/LLM are resolved, and runs a lightweight liveness check on each
(e.g. a tiny embedding call, a storage ping) with clear PASS/FAIL lines and
actionable hints pointing at .env.example.

Tasks: add the subcommand in cli/main.py; implement checks via the config
factory (src/contextseek/config/factory.py); never print secrets; exit
non-zero if any required component fails.

Acceptance: running contextseek doctor on a half-configured .env clearly
identifies the missing/broken piece.

ZH. 新用户经常把三大必需组件(存储后端、embedding、LLM)配错。请加一个
doctor 子命令:加载 ContextSeekSettings
src/contextseek/config/settings.py),报告当前解析到的后端/embedder/LLM,并对每
项做一次轻量存活检查(比如一次极小的 embedding 调用、一次存储 ping),用清晰的
PASS/FAIL 行 + 指向 .env.example 的修复提示呈现。

任务:cli/main.py 加子命令;通过配置工厂
src/contextseek/config/factory.py)实现检查;绝不打印任何密钥;任一必需组件失败
则非零退出。

验收: 对一个配了一半的 .envcontextseek doctor,能明确指出缺失/损坏的那
一项。

Describe the solution you'd like

contextseek doctor — config & connectivity self-check

Describe alternatives you've considered

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    OSS26OSS 2026 program — open, unclaimed task available to pick upcomp:cliContextSeek component: clipriority:highShould be addressed soon

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions