HoHu CLI
HoHu CLI 是创建、开发和部署 HoHu 项目的命令行工具。第一次运行应用,请按开发环境教程完成配置;需要部署到服务器,请阅读部署指南。本部分用于查找命令、参数和执行结果。
命令速查
点击命令查看参数与示例。方括号表示可选参数,... 表示可以传入多个值,使用时不输入这些标记。
终端中使用 hohu <命令> --help 查看帮助,例如 hohu create --help 或 hohu deploy logs --help。
| 命令 | 用途 |
|---|---|
hohu create [NAME] | 创建项目,选择 Backend、Web 和 App |
hohu init | 安装项目依赖,执行后端初始化 |
hohu dev | 在前台启动开发服务 |
hohu build | 从源码构建 Backend/Web 的 Docker 镜像 |
hohu deploy init | 生成部署配置与首次凭据 |
hohu deploy | 准备镜像、迁移数据并启动应用 |
hohu deploy ps | 查看部署服务状态 |
hohu deploy logs [SERVICES...] | 查看日志,支持 -f 持续跟踪 |
hohu deploy restart [SERVICES...] | 重启全部或指定服务 |
hohu deploy down | 停止并移除部署容器 |
hohu deploy pull | 更新镜像,执行迁移并启动服务 |
hohu deploy upgrade | 更新项目根仓库源码、构建并重新部署 |
hohu migrate | 单独运行部署环境迁移与种子同步 |
hohu monitoring init | 准备 Prometheus/Grafana 配置 |
hohu monitoring up | 启动监控服务 |
hohu monitoring ps | 查看监控服务状态 |
hohu monitoring logs [SERVICES...] | 查看监控日志 |
hohu monitoring restart [SERVICES...] | 重启监控服务 |
hohu monitoring down | 停止并移除监控容器 |
hohu skills install | 为编程助手安装 HoHu Skills |
hohu lang | 选择 CLI 语言 |
hohu info | 查看 CLI 版本和全局配置位置 |
hohu --version | 查看 CLI 版本 |
hohu --help | 查看命令列表 |
hohu --show-completion | 输出当前 Shell 的补全脚本 |
hohu --install-completion | 为当前 Shell 安装命令补全 |
hohu system lang 和 hohu system info 分别与 hohu lang、hohu info 等价。
安装与升级
CLI 需要 Python 3.10+,推荐使用 uv 安装:
uv tool install hohu
hohu --version
hohu --help安装 uv 请参考 uv 安装说明。如果提示找不到 hohu,执行 uv tool update-shell,按提示刷新 PATH 或重新打开终端。
升级 CLI:
uv tool upgrade hohu使用统一的 --source / -s 参数选择来源,各命令支持的值见按命令选择来源。
升级 CLI 不会自动更新已创建项目的源码、依赖或部署镜像。组件发布记录见更新说明。如果已安装版本缺少本文中的参数,先检查该命令的 --help,再升级到支持所需功能的版本。
CLI 的 Python 要求与应用不同。开发 Backend/Web 还需 Git、后端 Python、Node.js、pnpm、PostgreSQL 和 Redis;版本要求见开发环境。构建和部署还需 Docker,部署与监控需 Docker Compose。
开始使用
准备好开发环境后,创建 Backend + Web 项目:
hohu create my-project --component backend --component web --non-interactive
cd my-project
hohu init
hohu devcreate 获取源码;init 安装依赖并执行初始化;dev 持续运行开发服务。数据库连接的首次配置、管理员凭据和登录步骤见开发环境教程。
使用编程助手时,先安装 HoHu Skills,再按 AI 辅助开发创建项目或开发业务模块。
命令在哪里运行
| 操作 | 运行位置 |
|---|---|
create | 新项目的父目录 |
init、dev、build | 含 .hohu/project.json 的项目根目录,或其子目录 |
deploy init | 计划保存部署配置的目录;配置写入当前目录的 .hohu/deploy/ |
| 其他部署、迁移与监控命令 | 已初始化部署目录的上级目录,或其子目录 |
deploy upgrade | 同时满足项目标记、部署配置和根目录 Git 仓库要求的项目内 |
skills install | 编程助手准备使用的工作区;也可选择用户范围安装 |
lang、info、--help、--version | 任意目录 |
开发后端使用 hohu-admin/.env,部署使用 .hohu/deploy/.env。遇到错误时先核对运行目录和目标配置,见配置与排错。
