docs:README 補上完整安裝指南(#15)

This commit is contained in:
ceo
2026-09-10 10:48:12 +08:00
parent 0b0c3cefcb
commit 9948357f52
+36 -1
View File
@@ -11,12 +11,47 @@ teai 是 Gitea 的命令列(CLI)工具,以更完整、更可靠的方式
## 安裝與建置
需要 Go 1.26 以上。
### 需求
- **Go 1.26 以上**(`go version` 確認;本倉庫僅用標準庫,離線可建置)
- **git**
- Gitea 帳號的 **API token**(設定階段使用;在 Gitea「設定 → 應用程式」產生)
### 從原始碼建置
```sh
git clone https://gitea.alterminal.com/alterminal/teai.git
cd teai
go build -o teai ./cmd/teai
install -Dm755 teai ~/.local/bin/teai # 或複製到任何 PATH 內目錄
teai version # 驗證:teai version 0.1.0-dev
```
也可以直接裝進 `GOBIN`(預設 `~/go/bin`;該目錄已在 PATH 時最省事):
```sh
go install ./cmd/teai
```
> **注意:** `go install gitea.alterminal.com/alterminal/teai/cmd/teai@latest` 目前**不可用**——
> module 尚未發佈任何 tag,`@latest` 會解析到任意中繼 commit(且 #21 修復前 main 建置失敗)。
> 請在 clone 目錄內以版本控制的方式建置;發佈 tag 後再提供 `teai@<version>` 安裝路徑。
### 登入設定(首次使用)
teai 與 `tea` 共用同一份組態檔;若 `tea whoami` 已可正常輸出,可跳過本節。
```sh
teai login add --url https://gitea.alterminal.com
# 未給 --token 時自 stdin 讀一行:貼上 token 後按 Enter(不會進 shell 歷史)
teai whoami # 驗證:應輸出 {"username":"<你的帳號>"}
```
- token 驗證失敗(HTTP 401)不會寫入組態,結束碼 3。
- 組態檔:`--config`/`TEA_CONFIG` 指定,預設 `~/.config/tea/config.yml`;teai 採行級編輯,
不會改壞 tea 也在使用的欄位,檔案權限 `0600`。
- 多站台以 `--name` 區分、`teai login default <名稱>` 切換預設;詳見下方 [`teai login`](#teai-login--管理登入) 一節。
## 指令設計
> 工作流規則的唯一來源是 [`alterminal/agents`](https://gitea.alterminal.com/alterminal/agents) 的 `AGENTS.md`;