Skip to content

Commit 06512bc

Browse files
ryco2048claude
andcommitted
docs: expand CLAUDE.md with prerequisites, usage, and output details
Add Prerequisites, Script Usage, Folder Naming Convention, and Outputs sections so Claude Code has full context for script invocations and non-obvious runtime behaviors (SEVENZIP_PATH, -Parallel caveat, manifest.csv, integrity-check behavior). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 177fafd commit 06512bc

1 file changed

Lines changed: 28 additions & 1 deletion

File tree

CLAUDE.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,40 @@ PowerShell scripts that compress GOG/Steam game folders into `.7z` archives for
99
- **No automated tests** — scripts are validated manually on Windows
1010
- **Large game directories are gitignored:** `GOG-Archive/`, `Steam-Archive/`, `GameVault-Ready/`
1111

12+
## Prerequisites
13+
14+
- Windows: 7-Zip installed (`C:\Program Files\7-Zip\7z.exe`) or set `$env:SEVENZIP_PATH`
15+
- macOS (dev): `brew install gitleaks`
16+
1217
## Setup (after clone)
1318

1419
```bash
1520
bash scripts/install-hooks.sh # sets core.hooksPath → scripts/hooks
1621
```
1722

18-
Requires `gitleaks` installed (`brew install gitleaks`) for pre-commit secret scanning.
23+
## Script Usage
24+
25+
```powershell
26+
# Prepare-GamesForGameVault.ps1 — interactive; prompts for title, year, source
27+
.\Prepare-GamesForGameVault.ps1 [-EmitSha256]
28+
29+
# Compress-ForGameVault.ps1 — batch; folders must already be named correctly
30+
.\Compress-ForGameVault.ps1 [-Force] [-SkipIntegrityCheck] [-Parallel] [-EmitSha256]
31+
# -Parallel only helps when source and dest are on different physical drives
32+
# Custom sources: -Sources @{ GOG='D:\GOG'; Itch='E:\Itch' }
33+
```
34+
35+
## Folder Naming Convention
36+
37+
GameVault requires: `Game Title (YYYY)` — must end with `(4-digit year)`.
38+
`Prepare-GamesForGameVault.ps1` enforces this interactively.
39+
`Compress-ForGameVault.ps1` validates and skips non-conforming folders.
40+
41+
## Outputs
42+
43+
- `.7z` archives → `GameVault-Ready/` (gitignored)
44+
- `manifest.csv` in destination — one row per successful compression
45+
- Existing archives are integrity-checked (`7z t`) before skipping; use `-SkipIntegrityCheck` to bypass
1946

2047
## Security
2148

0 commit comments

Comments
 (0)