From bc66add7edd0402256e6f794c1a010cbea3d1ff1 Mon Sep 17 00:00:00 2001 From: Codeman maintainer Date: Wed, 22 Jul 2026 12:52:47 +0200 Subject: [PATCH] docs: sync READMEs with the 1.6.2 installer behavior Quick Start now documents the consent-first flow (every system change is prompted; the closing menu chooses terminal / background service / skip), safe re-runs (finished installs update in place with local changes stashed and the service restart verified; interrupted installs resume full setup; install.sh update/uninstall), and the headless contract (system-changing steps abort without CODEMAN_NONINTERACTIVE=1). The AI CLI note now says all four CLIs are auto-detected with an install-or-skip choice when none exist, and the background-service section points at installer menu option 2 before the manual instructions. Same changes mirrored in README.zh-CN.md. Co-Authored-By: Claude Fable 5 --- README.md | 10 ++++++++-- README.zh-CN.md | 10 ++++++++-- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d21709f0..adb2ab51 100644 --- a/README.md +++ b/README.md @@ -32,9 +32,13 @@ curl -fsSL https://raw.githubusercontent.com/Ark0N/Codeman/master/install.sh | bash ``` -This installs Node.js and tmux if missing, clones Codeman to `~/.codeman/app`, and builds it. +This installs Node.js and tmux if missing, clones Codeman to `~/.codeman/app`, and builds it. A few things worth knowing: -You'll need at least one AI coding CLI installed — [Claude Code](https://docs.anthropic.com/en/docs/claude-code), [OpenCode](https://opencode.ai), [Codex](https://developers.openai.com/codex/cli), or [Gemini CLI](https://github.com/google-gemini/gemini-cli) (any combination works). After install: +- **It asks first.** Every system change (package installs, AI CLI download) is prompted, and a menu at the end lets you choose: run Codeman in this terminal, install it as a background service (systemd/launchd, auto-start on boot), or don't start yet. Nothing runs in the background unless you pick it. +- **Re-run to update.** The same one-liner updates a finished install in place: local changes in `~/.codeman/app` are stashed (never discarded), and a running service is restarted and verified. If a first install was interrupted, re-running resumes the full setup instead. `install.sh update` and `install.sh uninstall` also exist. +- **CI / headless:** without a terminal attached, steps that would change your system abort with instructions instead of running silently. Set `CODEMAN_NONINTERACTIVE=1` to approve them for automation. + +You'll need at least one AI coding CLI installed — [Claude Code](https://docs.anthropic.com/en/docs/claude-code), [OpenCode](https://opencode.ai), [Codex](https://developers.openai.com/codex/cli), or [Gemini CLI](https://github.com/google-gemini/gemini-cli) (any combination works). The installer detects whichever of the four is present; if none is found, it offers to install Claude Code or OpenCode, or you can skip and install one yourself later. After install: ```bash codeman web @@ -53,6 +57,8 @@ Details in [Multi-User Mode](#multi-user-mode-opt-in) below.
Run as a background service +The installer's final menu sets this up for you (option 2) and verifies the service actually comes up before claiming success. To configure it manually instead: + **Linux (systemd):** ```bash diff --git a/README.zh-CN.md b/README.zh-CN.md index 121d79d8..5f6818fe 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -34,9 +34,13 @@ curl -fsSL https://raw.githubusercontent.com/Ark0N/Codeman/master/install.sh | bash ``` -该脚本会在缺失时自动安装 Node.js 和 tmux，把 Codeman 克隆到 `~/.codeman/app` 并完成构建。 +该脚本会在缺失时自动安装 Node.js 和 tmux，把 Codeman 克隆到 `~/.codeman/app` 并完成构建。几点须知： -你至少需要安装一个 AI 编程 CLI —— [Claude Code](https://docs.anthropic.com/en/docs/claude-code)、[OpenCode](https://opencode.ai)、[Codex](https://developers.openai.com/codex/cli) 或 [Gemini CLI](https://github.com/google-gemini/gemini-cli)（任意组合均可）。安装完成后： +- **先询问，后改动。** 所有系统级改动（安装软件包、下载 AI CLI）都会先征求确认；结束时的菜单可选择：直接在本终端运行、安装为后台服务（systemd/launchd，开机自启），或暂不启动。不选就不会有任何后台进程。 +- **重跑即更新。** 再次运行同一条命令即可原地更新已完成的安装：`~/.codeman/app` 中的本地改动会被 stash（绝不丢弃），运行中的服务会自动重启并校验。若首次安装中途失败，重跑会继续完成完整的安装流程。也可以使用 `install.sh update` 与 `install.sh uninstall`。 +- **CI / 无终端环境：** 没有终端时，涉及系统改动的步骤会带着说明中止，而不是静默执行；在自动化场景设置 `CODEMAN_NONINTERACTIVE=1` 即可批准这些步骤。 + +你至少需要安装一个 AI 编程 CLI —— [Claude Code](https://docs.anthropic.com/en/docs/claude-code)、[OpenCode](https://opencode.ai)、[Codex](https://developers.openai.com/codex/cli) 或 [Gemini CLI](https://github.com/google-gemini/gemini-cli)（任意组合均可）。安装器会自动检测这四个中已安装的任意一个；若一个都没有，会提供安装 Claude Code 或 OpenCode 的选项，也可以选择跳过、稍后自行安装。安装完成后： ```bash codeman web @@ -55,6 +59,8 @@ codeman web --multiuser # 命名登录 + 按用户隔离的案例
作为后台服务运行 +安装器结尾的菜单（选项 2）可以帮你完成这一步，并在宣告成功前校验服务确实已启动。如需手动配置： + **Linux（systemd）：** ```bash