跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://ahvn.top/llms.txt

Use this file to discover all available pages before exploring further.

hb 是 HeavenBase 的浅层命令行入口，底层复用 Python API。它用于初始化全局配置、查看工作区注册表、编辑配置，以及调用已配置的 LLM preset。 
hb --help
hb -v
hb setup

​
初始化和路径

hb setup 初始化全局 HeavenBase 配置存储，并注册默认工作区。它不会在当前目录创建本地 .heavenbase/ 文件夹。 
hb setup
hb setup --reset
hb pj 解析 HeavenBase 路径别名，例如 %/ 表示包状态目录，&/ 表示资源目录。 
hb pj %/config.db
hb pj '&/configs/default.yaml'

​
工作区

hb ws 管理全局工作区注册表。 
hb ws list
hb ws get
hb ws set default --active
hb ws activate default
hb ws deactivate
hb ws open default
hb ws health default
hb ws unset scratch
帮助表格会直接显示命令别名，例如 list|ls、activate|act|use、deactivate|deact、set|add、unset|remove|rm|del|delete。

​
配置

hb config 通过 ConfigManager 编辑 HeavenBase 配置。短别名是 hb cfg。 
hb config get heavenbase.llm.default_preset
hb config list heavenbase.llm.presets
hb config set heavenbase.llm.default_preset mock
hb config add heavenbase.llm.presets.custom.tags cli
hb config unset heavenbase.llm.default_preset
hb config copy heavenbase.llm --source default
hb config history --limit 5
hb config scope
hb config diff
hb config edit --scope heavenbase
hb config reset --scope heavenbase.scratch
hb config compact --scope heavenbase
使用 --scope 指定配置层，使用 --version 读取保留历史，使用 --json 输出 JSON 或按 JSON 解析配置值。 别名：hb cfg ls / show、hb cfg rm / remove / del / delete、hb cfg cp、hb cfg hist。

​
LLM

hb llm 调用 LLM 配置系统。preset、provider、model、gateway 的解析规则与 Python 里的 hb.LLM(...) 相同。 
hb llm chat "Summarize HeavenBase in one sentence."
hb llm chat --preset mock --provider mock --gateway mock --no-stream --verbose "hello"
hb llm embed "semantic text" --json
hb llm session --preset chat
hb llm imagen "a simple product diagram" --output ./image.png
hb llm status --preset mock
hb llm verbose --preset chat-pro
hb llm list presets
hb llm ls providers
通用 LLM 选项包括 --preset / -p、--model / -m、--provider / -b、--gateway / -g、--cache / --no-cache，调用类命令还支持 --verbose / -v。chat、embed 和 session 还支持重复传入 --input 文件。 hb llm verbose 会显示解析后的非密钥 LLM 参数。resolve 仍是别名，帮助里显示为 verbose|resolve。hb llm list|ls 可列出 presets、providers、models、gateways 或 all。 如果模型返回 reasoning / think 内容，CLI 会先用灰色输出这部分，再输出普通回答。 交互式 hb llm session 支持 /help、/save、/load、/clear、/regen、/back、/exit，以及 /s、/l、/r、/b 等短命令。

​
后端

默认 CLI 后端是 Typer。HeavenBase 也可以把同一套命令注册表编译成 Click 和 argparse，便于嵌入宿主应用。 
from heavenbase.cli import create_cli

typer_app = create_cli("typer")
click_app = create_cli("click")
argparse_parser = create_cli("argparse")