Skip to content

Commit ee3fb66

Browse files
committed
docs: add AI-assisted Windows install guide
1 parent 3b251f4 commit ee3fb66

5 files changed

Lines changed: 94 additions & 4 deletions

File tree

README.ja.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,20 @@ uv run --locked python -m benchmarks.retrieval_quality \
194194

195195
### ネイティブ Windows
196196

197-
PowerShell を開き、バージョンが固定されたインストーラーをダウンロードして内容を確認した後、実行します:
197+
最も簡単な方法は、AI コーディングアシスタントに公式リポジトリのリンクを渡し、インストールと検証を依頼することです。Windows PC でコマンドを実行できる Claude Code、Codex などのエージェントに、次のプロンプトをそのまま貼り付けてください:
198+
199+
```text
200+
Install WikiBrain on this Windows machine from https://github.com/hungrytech/wikibrain.
201+
Read the repository's Native Windows instructions first. Before changing anything,
202+
tell me whether native Windows or WSL is the correct path for where my agents and
203+
repositories run. Use the version-pinned installer from the README. Download it,
204+
show me the full PowerShell script, explain the settings changed by initialization,
205+
then stop and wait for my explicit approval before running the script or initializing
206+
WikiBrain. After I approve, install it and finish by running brainctl doctor.
207+
Do not bypass Codex hook trust.
208+
```
209+
210+
AI が提示した計画と権限要求を確認してから進めてください。手動でインストールする場合は、PowerShell を開き、バージョンが固定されたインストーラーをダウンロードして内容を確認した後、実行します:
198211

199212
```powershell
200213
$installer = Join-Path $env:TEMP "install-wikibrain.ps1"

README.ko.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,23 @@ Intel macOS, x86_64 Linux용 bottle을 제공합니다.
228228

229229
### 네이티브 Windows
230230

231-
PowerShell에서 버전이 고정된 설치 스크립트를 내려받아 검토한 뒤 실행합니다.
231+
가장 쉬운 방법은 AI 코딩 도구에 공식 저장소 링크를 주고 설치와 검증을 요청하는
232+
것입니다. Windows PC에서 명령을 실행할 수 있는 Claude Code, Codex 등의
233+
에이전트에 아래 내용을 그대로 붙여 넣으세요.
234+
235+
```text
236+
Install WikiBrain on this Windows machine from https://github.com/hungrytech/wikibrain.
237+
Read the repository's Native Windows instructions first. Before changing anything,
238+
tell me whether native Windows or WSL is the correct path for where my agents and
239+
repositories run. Use the version-pinned installer from the README. Download it,
240+
show me the full PowerShell script, explain the settings changed by initialization,
241+
then stop and wait for my explicit approval before running the script or initializing
242+
WikiBrain. After I approve, install it and finish by running brainctl doctor.
243+
Do not bypass Codex hook trust.
244+
```
245+
246+
AI가 제시한 계획과 권한 요청을 확인한 뒤 진행하세요. 직접 설치하려면 PowerShell에서
247+
버전이 고정된 설치 스크립트를 내려받아 검토한 뒤 실행합니다.
232248

233249
```powershell
234250
$installer = Join-Path $env:TEMP "install-wikibrain.ps1"

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,23 @@ cover Apple Silicon macOS, Intel macOS, and x86_64 Linux.
236236

237237
### Native Windows
238238

239-
Open PowerShell, download the versioned installer, review it, then run it:
239+
The easiest route is to give your AI coding assistant the official repository
240+
link and ask it to perform and verify the installation. Paste this prompt into
241+
Claude Code, Codex, or another agent that can run commands on your Windows PC:
242+
243+
```text
244+
Install WikiBrain on this Windows machine from https://github.com/hungrytech/wikibrain.
245+
Read the repository's Native Windows instructions first. Before changing anything,
246+
tell me whether native Windows or WSL is the correct path for where my agents and
247+
repositories run. Use the version-pinned installer from the README. Download it,
248+
show me the full PowerShell script, explain the settings changed by initialization,
249+
then stop and wait for my explicit approval before running the script or initializing
250+
WikiBrain. After I approve, install it and finish by running brainctl doctor.
251+
Do not bypass Codex hook trust.
252+
```
253+
254+
Review the AI's plan and every permission prompt. If you prefer to install it
255+
manually, open PowerShell, download the versioned installer, review it, then run it:
240256

241257
```powershell
242258
$installer = Join-Path $env:TEMP "install-wikibrain.ps1"

README.zh-CN.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,20 @@ Apple Silicon macOS、Intel macOS 和 x86_64 Linux。
212212

213213
### 原生 Windows
214214

215-
打开 PowerShell,下载指定版本的安装程序,审查后再运行:
215+
最简单的方法是把官方仓库链接交给 AI 编程助手,请它完成安装并进行验证。将以下提示原样粘贴到能够在你的 Windows 电脑上执行命令的 Claude Code、Codex 或其他智能体中:
216+
217+
```text
218+
Install WikiBrain on this Windows machine from https://github.com/hungrytech/wikibrain.
219+
Read the repository's Native Windows instructions first. Before changing anything,
220+
tell me whether native Windows or WSL is the correct path for where my agents and
221+
repositories run. Use the version-pinned installer from the README. Download it,
222+
show me the full PowerShell script, explain the settings changed by initialization,
223+
then stop and wait for my explicit approval before running the script or initializing
224+
WikiBrain. After I approve, install it and finish by running brainctl doctor.
225+
Do not bypass Codex hook trust.
226+
```
227+
228+
确认 AI 给出的计划和所有权限请求后再继续。如果你希望手动安装,请打开 PowerShell,下载指定版本的安装程序,审查后再运行:
216229

217230
```powershell
218231
$installer = Join-Path $env:TEMP "install-wikibrain.ps1"

tests/test_windows_packaging.py

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,38 @@ def test_installer_and_readmes_use_the_release_version(self) -> None:
2626
self.assertIn(expected_path, english)
2727
self.assertIn(expected_path, korean)
2828

29+
def test_all_readmes_offer_a_safe_ai_assisted_windows_install_prompt(self) -> None:
30+
prompt = """Install WikiBrain on this Windows machine from https://github.com/hungrytech/wikibrain.
31+
Read the repository's Native Windows instructions first. Before changing anything,
32+
tell me whether native Windows or WSL is the correct path for where my agents and
33+
repositories run. Use the version-pinned installer from the README. Download it,
34+
show me the full PowerShell script, explain the settings changed by initialization,
35+
then stop and wait for my explicit approval before running the script or initializing
36+
WikiBrain. After I approve, install it and finish by running brainctl doctor.
37+
Do not bypass Codex hook trust."""
38+
fenced_prompt = f"```text\n{prompt}\n```"
39+
pinned_installer = (
40+
f"/wikibrain/v{__version__}/scripts/install-windows.ps1"
41+
)
42+
43+
for readme_name in (
44+
"README.md",
45+
"README.ko.md",
46+
"README.ja.md",
47+
"README.zh-CN.md",
48+
):
49+
readme = (ROOT / readme_name).read_text(encoding="utf-8")
50+
native_start = readme.index('<a id="native-windows"></a>')
51+
native_end = readme.index("<details>", native_start)
52+
native_section = readme[native_start:native_end]
53+
with self.subTest(readme=readme_name):
54+
self.assertIn(fenced_prompt, native_section)
55+
self.assertIn(pinned_installer, native_section)
56+
self.assertLess(
57+
native_section.index(fenced_prompt),
58+
native_section.index("```powershell"),
59+
)
60+
2961
def test_windows_installer_is_review_first_and_does_not_use_iex(self) -> None:
3062
installer = (ROOT / "scripts" / "install-windows.ps1").read_text(
3163
encoding="utf-8"

0 commit comments

Comments
 (0)