02 — 入門
安裝
一行指令 macOS 與 Ubuntu 都搞定。安裝程式自動處理 Python、Docker、costaff CLI。
# macOS 或 Ubuntu
curl -fsSL https://raw.githubusercontent.com/costaff-ai/costaff/main/install.sh | bash
安裝程式做的事
- 偵測作業系統 — 只支援 macOS 與 Ubuntu/Debian,其他直接退出。
- 系統套件 — macOS 裝 Xcode CLT 與 Homebrew;Ubuntu 跑
apt。 - Python 3.12 — macOS Homebrew、Ubuntu
deadsnakesPPA(Ubuntu 24.04+ 已處理 — 退役的distutils套件會自動跳過)。 - Docker — macOS Docker Desktop、Ubuntu Docker Engine。macOS 上安裝程式會自動啟動 Docker Desktop 並等 daemon 就緒(最多 90 秒);Ubuntu 上若 daemon 沒在跑會用 systemd 拉起來。
- Repo — 把
costaff-ai/costaffclone 到~/.costaff/costaff/。 - 虛擬環境 — 建
~/.costaff/.venv/,跑pip install -e。 - PATH — 把 venv 寫進
~/.zshrc(macOS)或~/.bashrc(Ubuntu)。 - 設定精靈 — 沒有剩餘手動步驟時(例如不需要重新登入 docker group),安裝程式會直接接著跑
costaff onboard。
Ubuntu:docker group
安裝程式會把你加進 docker group,但在當下 shell 不會立即生效。先登出再登入,或在新的 shell 跑 newgrp docker,再進下一步。
確認 CLI 在 PATH 上
source ~/.zshrc # Ubuntu 改 ~/.bashrc
costaff --version
應該看到版本字串。如果是 command not found,檢查 $HOME/.costaff/.venv/bin 在不在 PATH 裡。
重跑安裝程式
安裝程式是冪等的。對已經裝好的環境再跑一次,會 git pull 主 repo 並重新 install CLI,但不會動 ~/.costaff/costaff/.env 或已註冊的 Agent。