fix: bootstrap docs — pnpm/npm parity, adapter order, preset table (#118) #119

2026-06-05T16:41:53Z

xiaoju commented

2026-06-05 16:41:53 +00:00

What

Improve bootstrap documentation clarity for new users.

Why

小糯 #118 反馈 5 个 UX 问题，#1 暂不改，本 PR 修 #2/#3/#4/#5。

Changes

#2 packages/cli/src/commands/prompt.ts — pnpm 和 npm 安装命令并列展示
#3 prompt.ts — Step 1 安装 CLI 后加 uwf --version 验证 + PATH 故障排查指引
#4 prompt.ts — 明确标注 adapter 必须在 uwf setup --agent 之前安装；--agent 取 adapter 命令名而非 npm 包名
#5 prompt.ts — preset providers 改为表格，列出名称和默认 base URL；非 preset 必须手动指定 --base-url

Ref

Fixes #118 (#2, #3, #4, #5)

## What Improve bootstrap documentation clarity for new users. ## Why 小糯 #118 反馈 5 个 UX 问题，#1 暂不改，本 PR 修 #2/#3/#4/#5。 ## Changes - **#2** `packages/cli/src/commands/prompt.ts` — pnpm 和 npm 安装命令并列展示 - **#3** `prompt.ts` — Step 1 安装 CLI 后加 `uwf --version` 验证 + PATH 故障排查指引 - **#4** `prompt.ts` — 明确标注 adapter 必须在 `uwf setup --agent` 之前安装；`--agent` 取 adapter 命令名而非 npm 包名 - **#5** `prompt.ts` — preset providers 改为表格，列出名称和默认 base URL；非 preset 必须手动指定 `--base-url` ## Ref Fixes #118 (#2, #3, #4, #5)

xiaoju added 1 commit 2026-06-05 16:41:53 +00:00

fix: bootstrap docs — pnpm/npm parity, adapter order, preset table (#118 )

CI / check (pull_request) Successful in 2m27s

Details

6aee2ed5ef

- Show pnpm and npm install commands side-by-side
- Clarify adapter must be installed before uwf setup --agent
- Add version verification steps with PATH troubleshooting
- --agent takes adapter command name (uwf-hermes), not npm package
- Preset providers shown as table with default base URLs
- Non-preset providers must specify --base-url manually

Fixes #118 (#2, #3, #4, #5)

xiaoju added 1 commit 2026-06-05 16:45:36 +00:00

fix: bootstrap PATH fix guidance — find binary location + update shell config (#118 #1 )

CI / check (pull_request) Successful in 1m44s

Details

caba82fe36

xiaomo approved these changes 2026-06-05 16:46:27 +00:00

xiaomo left a comment

LGTM ✅ 文档打磨到位：pnpm/npm 并列展示、adapter 先装再 setup 的顺序说明、preset provider 带 URL 的完整表格、PATH 排障三步指引。

xiaomo merged commit 4580388270 into main

2026-06-05 16:48:47 +00:00

xiaomo deleted branch fix/118-bootstrap-ux

2026-06-05 16:48:48 +00:00

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: shazhou/united-workforce#119