Skip to content

Commit fcbd59b

Browse files
committed
docs(npm): simplify current setup command
1 parent 1783bf6 commit fcbd59b

7 files changed

Lines changed: 21 additions & 27 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ REA shows how it reached its conclusions. It does not claim to recover original
8989
### Run setup — recommended
9090

9191
```bash
92-
npx --yes --prefer-online rea-agents@latest setup
92+
npx --yes rea-agents@latest setup
9393
```
9494

9595
The npm package-runner prompt, when shown, approves downloading REA for this
@@ -103,10 +103,10 @@ detected agents, then asks which capabilities to set up: agent integration
103103
Nothing is preselected. Choosing agent integration opens a second empty
104104
checklist for the specific detected agents that should receive a registration.
105105

106-
`@latest` makes the requested release explicit, and `--prefer-online` asks npm
107-
to refresh package metadata instead of relying on a cached resolution. REA does
108-
not silently replace the package version npm selected. Intentional rollbacks
109-
therefore remain available through an exact package request.
106+
`@latest` makes the requested release explicit and asks npm for the release
107+
currently published under that tag. REA does not silently replace the package
108+
version npm selected. Intentional rollbacks therefore remain available through
109+
an exact package request.
110110

111111
REA keeps the journey inline so its history remains in the terminal. Selecting
112112
a capability does not select every detected target or authorize a change.
@@ -137,7 +137,7 @@ Pass installer options after `bash -s --`, for example `--dry-run`, `--no-setup`
137137
### With an agent — recommended
138138

139139
```bash
140-
npx --yes --prefer-online rea-agents@latest setup
140+
npx --yes rea-agents@latest setup
141141
```
142142

143143
Choose Agent Integration in the reviewed setup plan. REA installs the pinned MCP
@@ -149,7 +149,7 @@ Review the setup plan, approve it if appropriate, then describe the app or featu
149149
### From Terminal — no installation
150150

151151
```bash
152-
npx --yes --prefer-online rea-agents@latest setup
152+
npx --yes rea-agents@latest setup
153153
npx -y rea-agents@latest doctor
154154
npx -y rea-agents@latest analyze /Applications/Notes.app
155155
```

README_ar.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ npx rea-agents setup
6565
### باستخدام وكيل برمجة — موصى به
6666

6767
```bash
68-
npx --yes --prefer-online rea-agents@latest setup
68+
npx --yes rea-agents@latest setup
6969
```
7070

7171
اطلب من الوكيل إعداد REA. سيفحص جهاز Mac ويشرح ما يحتاج إلى تثبيته ويطلب الموافقة ويرشدك خلال رسائل النظام. أعد تشغيل الوكيل بعد الإعداد إذا طلب ذلك لتحميل مجموعة الأدوات الكاملة.
@@ -90,7 +90,7 @@ npx --yes --prefer-online rea-agents@latest setup
9090

9191
```bash
9292
curl -fsSL https://raw.githubusercontent.com/morluto/rea/main/install.sh | bash
93-
npx --yes --prefer-online rea-agents@latest setup
93+
npx --yes rea-agents@latest setup
9494
```
9595

9696
إذا طلب macOS أو برنامج التثبيت تأكيدًا، فأكمل الخطوة ثم شغّل الأمر نفسه مرة أخرى.

README_ja.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ REA は調査をバイナリ上の根拠に結び付けます。元のソース
6767
### コーディングエージェントから(推奨)
6868

6969
```bash
70-
npx --yes --prefer-online rea-agents@latest setup
70+
npx --yes rea-agents@latest setup
7171
```
7272

7373
エージェントに REA のセットアップを依頼してください。Mac を確認し、必要なインストールを説明して承認を求め、システムプロンプトを案内します。完全なツールを読み込むため再起動を求められた場合は、セットアップ後に再起動してください。
@@ -91,7 +91,7 @@ Ubuntu 24.04+、Fedora 41+、64 ビット Arch Linux では、REA が公式の D
9191
```bash
9292
# 1. REA をセットアップ
9393
curl -fsSL https://raw.githubusercontent.com/morluto/rea/main/install.sh | bash
94-
npx --yes --prefer-online rea-agents@latest setup
94+
npx --yes rea-agents@latest setup
9595
```
9696

9797
macOS やインストーラーから確認を求められた場合は、その操作を完了してから同じコマンドをもう一度実行してください。

README_ko.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ REA는 분석을 바이너리 증거에 근거하게 합니다. 원본 소스
6767
### 코딩 에이전트에서 시작하기(권장)
6868

6969
```bash
70-
npx --yes --prefer-online rea-agents@latest setup
70+
npx --yes rea-agents@latest setup
7171
```
7272

7373
에이전트에게 REA 설정을 요청하세요. Mac을 확인하고 필요한 설치 내용을 설명한 뒤 승인을 요청하며 시스템 프롬프트를 안내합니다. 전체 도구를 불러오기 위해 재시작하라고 하면 설정 후 에이전트를 재시작하세요.
@@ -91,7 +91,7 @@ Ubuntu 24.04+, Fedora 41+, 64비트 Arch Linux에서 REA는 공식 DEB, RPM 또
9191
```bash
9292
# 1. REA 설정
9393
curl -fsSL https://raw.githubusercontent.com/morluto/rea/main/install.sh | bash
94-
npx --yes --prefer-online rea-agents@latest setup
94+
npx --yes rea-agents@latest setup
9595
```
9696

9797
macOS나 설치 프로그램이 확인을 요청하면 해당 절차를 완료하고 같은 명령을 다시 실행하세요.

README_zh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ REA 让调查始终以二进制证据为依据。它不会声称能恢复原始
6767
### 使用编程智能体(推荐)
6868

6969
```bash
70-
npx --yes --prefer-online rea-agents@latest setup
70+
npx --yes rea-agents@latest setup
7171
```
7272

7373
让智能体设置 REA。它会检查你的 Mac,说明需要安装的内容,先征得同意,并引导你处理系统提示。如果智能体要求重启以加载完整工具,请在设置后重启。
@@ -91,7 +91,7 @@ npx --yes --prefer-online rea-agents@latest setup
9191
```bash
9292
# 1. 安装和配置 REA
9393
curl -fsSL https://raw.githubusercontent.com/morluto/rea/main/install.sh | bash
94-
npx --yes --prefer-online rea-agents@latest setup
94+
npx --yes rea-agents@latest setup
9595
```
9696

9797
如果 macOS 或安装程序要求确认,请完成提示,然后再次运行同一命令。

docs/installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ REA separates installing its CLI from configuring external software and agents.
77
The recommended setup entrypoint is:
88

99
```bash
10-
npx --yes --prefer-online rea-agents@latest setup
10+
npx --yes rea-agents@latest setup
1111
```
1212

1313
If npm asks to download and run the package, that approval applies only to the
1414
current package-runner invocation. REA still prints its own setup plan and asks
1515
for separate approval before changing agent configuration or installing a
1616
product-owned component.
1717

18-
The explicit `@latest` request and `--prefer-online` metadata policy prevent a
19-
project dependency or stale npx cache entry from choosing the setup version.
18+
The explicit `@latest` request prevents a project dependency or stale npx cache
19+
entry from choosing the setup version.
2020
REA runs the version npm selected and never silently replaces an intentional
2121
version request after launch. To repair registrations written by an older
2222
release, rerun the command above and review the resulting setup plan.

tests/conformance/readmeConsistency.test.ts

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,7 @@ describe("localized README product facts", () => {
6767
"curl -fsSL https://raw.githubusercontent.com/morluto/rea/main/install.sh | bash",
6868
);
6969
expect(content).toContain("npx rea-agents setup");
70-
expect(content).toContain(
71-
"npx --yes --prefer-online rea-agents@latest setup",
72-
);
70+
expect(content).toContain("npx --yes rea-agents@latest setup");
7371
expect(content).toContain("npx -y rea-agents@latest doctor");
7472
expect(content).toContain("rea uninstall");
7573
expect(content).toContain(
@@ -98,17 +96,13 @@ describe("localized README product facts", () => {
9896
expect(content).toContain("--install-hopper");
9997
expect(content).toContain("docs/installation.md");
10098
expect(content).toContain("You do not need both");
101-
expect(content).toContain(
102-
"npx --yes --prefer-online rea-agents@latest setup",
103-
);
99+
expect(content).toContain("npx --yes rea-agents@latest setup");
104100
});
105101

106102
it("documents explicit setup freshness and rollback", async () => {
107103
const content = await readFile(resolve("docs/installation.md"), "utf8");
108104
const prose = normalizedProse(content);
109-
expect(prose).toContain(
110-
"explicit `@latest` request and `--prefer-online` metadata policy",
111-
);
105+
expect(prose).toContain("explicit `@latest` request");
112106
expect(prose).toContain(
113107
"npm exec --yes --package=rea-agents@2.4.0 -- rea setup",
114108
);

0 commit comments

Comments
 (0)