Skip to content

Commit ac5748a

Browse files
authored
Add Windows popcorn alias (#71)
1 parent 4c09e16 commit ac5748a

2 files changed

Lines changed: 20 additions & 7 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ powershell -ExecutionPolicy Bypass -Command "iwr -UseBasicParsing https://raw.gi
4545
```
4646

4747
After installation, restart your terminal (or run `source ~/.bashrc` / `source ~/.zshrc`).
48+
The release binary is named `popcorn-cli`; the one-line installers also add a
49+
`popcorn` alias, and the examples below use that shorter command.
4850

4951
### Option 2: Manual Installation
5052

@@ -55,8 +57,10 @@ After installation, restart your terminal (or run `source ~/.bashrc` / `source ~
5557
- Linux aarch64: `popcorn-cli-linux-aarch64.tar.gz`
5658
- macOS Apple Silicon: `popcorn-cli-macos.tar.gz`
5759
- Windows x86_64: `popcorn-cli-windows.zip`
58-
4. Extract the archive, move `popcorn-cli` into a directory on your `PATH`,
59-
and run `popcorn --version` to confirm the installed version.
60+
4. Extract the archive, move `popcorn-cli` (`popcorn-cli.exe` on Windows) into
61+
a directory on your `PATH`, and run `popcorn-cli --version` to confirm the
62+
installed version. The `popcorn` alias is created by the one-line installers;
63+
manual installs can use `popcorn-cli` directly.
6064

6165
Older versions are available from the same Releases page by selecting a previous
6266
tag.

install.ps1

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ $downloadUrl = "https://github.com/gpu-mode/popcorn-cli/releases/latest/download
1818
$tempDir = "$env:TEMP\popcorn-cli-install"
1919
$installDir = "$env:LOCALAPPDATA\popcorn-cli"
2020
$binaryPath = "$installDir\popcorn-cli.exe"
21+
$aliasPath = "$installDir\popcorn.cmd"
2122

2223
# Create directories
2324
try {
@@ -54,6 +55,13 @@ try {
5455
$fullBinaryPath = Join-Path $tempDir $binarySource
5556
Copy-Item $fullBinaryPath $binaryPath -Force
5657
Write-Host "Binary extracted and copied" -ForegroundColor Green
58+
59+
$aliasContent = @(
60+
"@echo off",
61+
"`"%~dp0popcorn-cli.exe`" %*"
62+
)
63+
Set-Content -Path $aliasPath -Value $aliasContent -Encoding ASCII
64+
Write-Host "Created alias: popcorn -> popcorn-cli.exe" -ForegroundColor Green
5765
} else {
5866
Write-Host "popcorn-cli.exe not found in archive" -ForegroundColor Red
5967
exit 1
@@ -104,16 +112,17 @@ Write-Host "Popcorn CLI installed and ready for hackathon!" -ForegroundColor Gre
104112
Write-Host ""
105113
Write-Host "Quick Start:" -ForegroundColor Cyan
106114
Write-Host " 1. Restart your terminal/PowerShell" -ForegroundColor White
107-
Write-Host " 2. Register with GitHub: popcorn-cli register github" -ForegroundColor White
108-
Write-Host " 3. Submit your solution: popcorn-cli submit --gpu MI300 --leaderboard amd-fp8-mm --mode test <your-file>" -ForegroundColor White
115+
Write-Host " 2. Register with GitHub: popcorn register github" -ForegroundColor White
116+
Write-Host " 3. Submit your solution: popcorn submit --gpu MI300 --leaderboard amd-fp8-mm --mode test <your-file>" -ForegroundColor White
109117
Write-Host ""
110118
Write-Host "Hackathon mode features:" -ForegroundColor Cyan
111119
Write-Host " - API URL pre-configured" -ForegroundColor White
112120
Write-Host " - GitHub authentication (no Discord setup needed)" -ForegroundColor White
113121
Write-Host " - All modes available: test, benchmark, leaderboard, profile" -ForegroundColor White
114122
Write-Host " - Clean user identification" -ForegroundColor White
115123
Write-Host ""
116-
Write-Host "Need help? Run: popcorn-cli --help" -ForegroundColor White
117-
Write-Host "Example: popcorn-cli submit --gpu MI300 --leaderboard amd-fp8-mm --mode test example.py" -ForegroundColor White
124+
Write-Host "Need help? Run: popcorn --help" -ForegroundColor White
125+
Write-Host "Example: popcorn submit --gpu MI300 --leaderboard amd-fp8-mm --mode test example.py" -ForegroundColor White
126+
Write-Host "Canonical binary: popcorn-cli.exe; alias command: popcorn" -ForegroundColor Gray
118127
Write-Host ""
119-
Write-Host "Installation location: $installDir" -ForegroundColor Gray
128+
Write-Host "Installation location: $installDir" -ForegroundColor Gray

0 commit comments

Comments
 (0)