@zengshushu/axi
v0.1.0
Published
CLI for deploying Axi — AI personal assistant
Downloads
23
Maintainers
Readme
axi
AI 个人助理一键部署 CLI 工具。通过 Docker 拉取镜像并启动服务,首次安装时引导用户完成 API Key 配置(浏览器弹窗或终端交互),配置写入 SQLite 数据库,无需手动编辑 .env 文件。
安装
npx axi init命令
| 命令 | 说明 |
| ------------------------- | ------------------------ |
| axi init | 从远端拉取镜像并部署 |
| axi init --local | 从当前目录构建镜像并部署 |
| axi init --local <path> | 从指定目录构建镜像并部署 |
| axi --help | 显示帮助信息 |
axi init 流程
- 环境检测 — 检查 Docker 是否安装并运行、Docker Compose v2+ 是否可用
- 端口检查 — 检测目标端口是否被占用,若被 Axi 自身占用则提示是否重新安装
- 准备基础设施 — 创建安装目录 (
~/.axi)、Docker volumes (axi-data、axi-workspace) - 获取镜像 — 远端模式拉取镜像;
--local模式从本地源码docker compose build - 启动服务 —
docker compose up -d,等待 HTTP 健康检查通过(最长 60s) - 配置引导 — 检测是否已初始化:
- 已有配置(升级模式)→ 跳过配置,保留现有数据
- 首次安装 → 有桌面环境时打开浏览器(在页面中弹窗配置),无桌面环境时进入终端交互配置
环境变量
| 变量 | 说明 | 默认值 |
| ------------- | --------------- | --------------------------------------------------- |
| AXI_DIR | 安装目录 | ~/.axi |
| AXI_PORT | 服务端口 | 7778 |
| AXI_IMAGE | Docker 镜像地址 | hkccr.ccs.tencentyun.com/zss-ccs/zss-agent:latest |
| AXI_VERSION | 镜像版本标签 | latest |
示例:
AXI_PORT=8080 npx axi init
# 本地开发:从项目源码构建镜像
axi init --local /path/to/axi服务管理
安装完成后,进入安装目录执行 Docker Compose 命令:
cd ~/.axi
docker compose logs -f # 查看日志
docker compose restart # 重启服务
docker compose down # 停止服务
docker compose pull && docker compose up -d # 升级开发
pnpm build # 构建 (esbuild → dist/index.mjs)
pnpm dev # 构建并运行系统要求
- Node.js >= 18
- Docker + Docker Compose v2+
