用途:作为使用 Halo CLI 的起点,提供安装、认证、配置文件、全局用法、JSON 输出与安全规则等共享指引。
安装:通过 npm 全局安装 npm install -g @halo-dev/cli,可执行文件名为 halo,用 halo --version 查看版本。
命令发现:从 halo --help 开始,可查看 auth、post、single-page、search、plugin、theme、attachment、backup、moment、comment、notification 等顶层区域帮助,也可查看具体命令帮助,如 halo post create --help。
认证与配置文件:多数命令需针对已认证的 Halo 配置文件运行。支持 bearer 令牌登录(halo auth login --profile local --url http://127.0.0.1:8090 --auth-type bearer --token <token>)和 basic 认证登录。配置文件相关命令包括 halo auth current、halo auth profile list/get/use/delete、halo auth profile doctor。配置元数据存于配置文件,密钥存于系统钥匙串;默认路径依次为 $HALO_CLI_CONFIG_DIR/config.json、$XDG_CONFIG_HOME/halo/config.json、~/.config/halo/config.json。
全局参数与 JSON:多数命令支持 --profile <name> 选择配置文件、--json 输出机器可读结果,如 halo post list --json。使用 --json 时应解析 stdout 的结构化 JSON,避免依赖表格输出,自动化时显式指定 profile。
安全规则:delete、uninstall、disable 及覆盖内容的 import/update 等命令具有破坏性或改变服务器状态。交互终端可能要求确认,非交互流程需按需使用 --force,且不应盲目重试变更类命令。
公开与认证工作流:多数命令区域需要认证,search 是主要例外,提供 --url 时可直接查询公开站点,如 halo search --keyword "halo" --url https://www.halo.run。
推荐流程:安装、登录并保存配置文件、验证当前配置文件、查看命令帮助、先运行只读命令、自动化时使用 --json、谨慎使用 --force。更深入的工作流可参考配套技能文档。