# OctoHz CLI 快速上手

`octohz` 是 OctoHz 的官方命令行工具，适合在终端里发布内容、管理私人资料、接手项目归档，也适合给 Codex、Claude Code 等智能体使用。

## 安装

需要 Node.js 18+。

```bash
npm install -g octohz
octohz --version
octohz --help
```

也可以临时运行：

```bash
npx octohz@latest --help
```

## 配置 Token

在账号设置页生成 `apiToken`，然后配置：

```bash
octohz config set-token <your-token>
octohz config show
```

密码库、主机、API 密钥这类私人加密功能使用 private key：

```bash
octohz config set-private-key <your-private-key>
```

公共文档写入需要 admin token：

```bash
octohz config set-admin-token <your-admin-token>
```

## 常用工作流

发布推荐：

```bash
octohz publish \
  --name "项目名称" \
  --intro "一句话介绍" \
  --description-file /tmp/desc.md \
  --category software \
  --buy-type 1 \
  --buy-text "https://example.com"
```

管理私人文档：

```bash
octohz doc list
octohz doc add --title "笔记标题" --content-file /tmp/note.md
octohz doc update 5 --content-file /tmp/note.md
```

接手项目：

```bash
octohz project onboard 1
octohz project task list 1
octohz project task claim 1 T003
```

八字排盘：

```bash
octohz bazi list
octohz bazi add --name "张三" --gender 0 --year 1990 --month 5 --day 15 --hour 10
```

我的风水：

```bash
octohz fengshui list
octohz fengshui add --name "家里" --facing-degree 174.3 --move-in-year 2024 \
  --birth-date 1990-01-01 --gender 0
```

## 常见命令

```bash
octohz search "关键词"
octohz product list --q "AI"
octohz todo list
octohz nav list
octohz stock list
octohz resource list
octohz restaurant list
octohz recipe list
```

## 下一步

完整命令和参数请看：

- [OctoHz CLI 命令参考](https://octohz.com/docs?doc=83)
- [OctoHz CLI 智能体协作指南](https://octohz.com/docs?doc=80)
- [OctoHz CLI 故障排查](https://octohz.com/docs?doc=81)
- [旧版完整手册](https://octohz.com/docs?doc=77)


---

**分类**：Octohz CLI（命令行界面）
**链接**：https://octohz.com/docs?doc=82