Skip to content

Commit 3d090ee

Browse files
Tah10ngarysheng
authored andcommitted
fix windows install first-run parity
1 parent 997d329 commit 3d090ee

3 files changed

Lines changed: 537 additions & 231 deletions

File tree

README.md

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -63,30 +63,37 @@ sudo apt update; sudo apt install -y ffmpeg
6363
### Option 3: Installer for Windows
6464

6565
```powershell
66-
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/PeonPing/peon-ping/main/install.ps1" -UseBasicParsing | Invoke-Expression
66+
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/PeonPing/peon-ping/main/install.ps1" -OutFile ".\install.ps1" -UseBasicParsing
67+
powershell -ExecutionPolicy Bypass -File .\install.ps1
6768
```
6869

69-
Installs 5 curated packs by default (Warcraft, StarCraft, Portal). Re-run to update while preserving config/state. Or **[pick your packs interactively at peonping.com](https://peonping.com/#picker)** and get a custom install command.
70+
Installs a curated starter set of packs by default. Re-run to update while preserving config/state. Or **[pick your packs interactively at peonping.com](https://peonping.com/#picker)** and get a custom install command.
7071

71-
Useful installer flags:
72+
Windows installer parameters:
7273

73-
- `--all` — install all available packs
74-
- `--packs=peon,sc_kerrigan,...` — install specific packs only
75-
- `--local` — install packs, config, and hooks into `./.claude/` for the current project
76-
- `--global` — explicit global install (same as default)
77-
- `--init-local-config` — create `./.claude/hooks/peon-ping/config.json` only
74+
- `-All` — install all available packs
75+
- `-Packs peon,sc_kerrigan,...` — install specific packs only
76+
- `-Lang en,fr,...` — install only packs matching language(s)
77+
- `-Local` — install packs, config, hooks, and skills into `./.claude/` for the current project
78+
- `-Global` — explicit global install (same as default)
79+
- `-InitLocalConfig` — create `./.claude/hooks/peon-ping/config.json` only
7880

79-
`--local` does not modify your shell rc files (no global `peon` alias/completion injection). Hooks are registered in the project-level `./.claude/settings.json` with absolute paths so they work from any working directory within the project.
81+
`-Local` does not install the global `peon` CLI shim or modify your user `PATH`. Hooks are registered in the project-level `./.claude/settings.json` with absolute paths so they work from any working directory within the project.
8082

81-
Examples:
83+
Windows examples:
8284

83-
```bash
84-
curl -fsSL https://raw.githubusercontent.com/PeonPing/peon-ping/main/install.sh | bash -s -- --all
85-
curl -fsSL https://raw.githubusercontent.com/PeonPing/peon-ping/main/install.sh | bash -s -- --packs=peon,sc_kerrigan
86-
curl -fsSL https://raw.githubusercontent.com/PeonPing/peon-ping/main/install.sh | bash -s -- --local
85+
```powershell
86+
powershell -ExecutionPolicy Bypass -File .\install.ps1 -All
87+
powershell -ExecutionPolicy Bypass -File .\install.ps1 -Packs peon,sc_kerrigan
88+
powershell -ExecutionPolicy Bypass -File .\install.ps1 -Local
89+
powershell -ExecutionPolicy Bypass -File .\install.ps1 -InitLocalConfig
8790
```
8891

89-
If a global install exists and you install local (or vice versa), the installer prompts you to remove the existing one to avoid conflicts.
92+
If the initial download fails with a TLS error on older Windows PowerShell, run this once in the same session and retry:
93+
94+
```powershell
95+
[Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12
96+
```
9097

9198
### Option 4: Clone and inspect first
9299

@@ -96,6 +103,14 @@ cd peon-ping
96103
./install.sh
97104
```
98105

106+
On Windows PowerShell:
107+
108+
```powershell
109+
git clone https://github.com/PeonPing/peon-ping.git
110+
Set-Location peon-ping
111+
.\install.ps1
112+
```
113+
99114
### Option 5: Nix (macOS, Linux)
100115

101116
Run directly from source without installing:
@@ -233,6 +248,8 @@ Need to mute sounds and notifications during a meeting or pairing session? Two o
233248

234249
Other CLI commands:
235250

251+
> Windows note: Windows currently supports the day-one controls (`status`, `toggle`, `volume`, core `packs`, `notifications on/off`, `debug`, `logs`, `trainer`). More advanced commands like `setup`, `rotation`, `preview`, and `mobile` are tracked as follow-up Windows parity work.
252+
236253
```bash
237254
peon setup # Interactive setup wizard (volume, categories, notifications)
238255
peon pause # Mute sounds
@@ -1207,7 +1224,7 @@ Mobile notifications fire on every event regardless of window focus — they're
12071224

12081225
## Sound packs
12091226

1210-
165 packs across Warcraft, StarCraft, Red Alert, Portal, Zelda, Dota 2, Helldivers 2, Elder Scrolls, and more. The default install includes 5 curated packs:
1227+
165 packs across Warcraft, StarCraft, Red Alert, Portal, Zelda, Dota 2, Helldivers 2, Elder Scrolls, and more. The default install includes a curated starter set; commonly used packs include:
12111228

12121229
| Pack | Character | Sounds |
12131230
|---|---|---|

0 commit comments

Comments
 (0)