Skip to content

fix: use explorerctl on Windows #451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FllipEis merged 1 commit into from
Aug 22, 2026
Merged

fix: use explorerctl on Windows #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions .github/workflows/test-cli-installer.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,11 @@ jobs:
env:
EXPLORER_INSTALL_DIR: ${{ runner.temp }}/explorer-bin
NO_COLOR: 1
run: ./scripts/install.sh
run: |
./scripts/install.sh
echo "$EXPLORER_INSTALL_DIR" >> "$GITHUB_PATH"
- name: run the installed CLI
run: $RUNNER_TEMP/explorer-bin/explorer version
run: explorer version

windows:
runs-on: windows-latest
Expand All @@ -42,7 +44,9 @@ jobs:
env:
EXPLORER_INSTALL_DIR: ${{ runner.temp }}\explorer-bin
NO_COLOR: 1
run: ./scripts/install.ps1
run: |
./scripts/install.ps1
$env:EXPLORER_INSTALL_DIR | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
- name: run the installed CLI
shell: pwsh
run: '& "$env:RUNNER_TEMP\explorer-bin\explorer.exe" version'
run: explorerctl version
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ irm https://raw.githubusercontent.com/spacechunks/explorer/main/scripts/install.
```

This installs the latest version of the CLI.
On Windows, use `explorerctl` instead of `explorer`.

## License
This project uses two different licenses: AGPLv3 and LGPLv3. Everything found under under the `api/` folder is licensed under LGPLv3 while everything else is covered by AGPLv3, if not stated otherwise.
1 change: 1 addition & 0 deletions docs/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ irm https://raw.githubusercontent.com/spacechunks/explorer/main/scripts/install.
```

The installer downloads the latest version of the CLI.
On Windows, use `explorerctl` instead of `explorer`.

## Concepts

Expand Down
6 changes: 3 additions & 3 deletions scripts/install.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
$ErrorActionPreference = "Stop"

$repositoryUrl = "https://github.com/spacechunks/explorer"
$binaryName = "explorer.exe"
$binaryName = "explorerctl.exe"
$tempDirectory = $null

function Write-Brand {
Expand Down Expand Up @@ -127,7 +127,7 @@
New-Item -ItemType Directory -Path $installDirectory -Force | Out-Null
$installedBinary = Join-Path $installDirectory $binaryName
Copy-Item -LiteralPath $sourceBinary -Destination $installedBinary -Force
Write-Step "Installed explorer to $installedBinary"
Write-Step "Installed explorerctl to $installedBinary"

$pathEntries = @($env:Path -split ';' | Where-Object { -not [string]::IsNullOrWhiteSpace($_) })
if (-not ($pathEntries | Where-Object { $_.TrimEnd("\") -ieq $installDirectory.TrimEnd("\") })) {
Expand All @@ -148,7 +148,7 @@
Write-Host ""
Write-Host "Explorer CLI is ready."
Write-Host "Run " -NoNewline
Write-Host "explorer --help" -NoNewline
Write-Host "explorerctl --help" -NoNewline
Write-Host " to get started."
Write-Host ""
} catch {
Expand Down
3 changes: 2 additions & 1 deletion scripts/install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ case "$kernel" in
MINGW* | MSYS* | CYGWIN*)
operating_system="windows"
operating_system_label="Windows"
binary_name="explorerctl"
binary_extension=".exe"
;;
*)
Expand Down Expand Up @@ -176,7 +177,7 @@ step "Installed $binary_name to $installed_binary"
printf '\n%sExplorer CLI is ready.%s\n' "$bold" "$reset"
case ":${PATH:-}:" in
*":$install_dir:"*)
printf 'Run %sexplorer --help%s to get started.\n\n' "$bold" "$reset"
printf 'Run %s%s --help%s to get started.\n\n' "$bold" "$binary_name" "$reset"
;;
*)
printf 'Add the installation directory to your PATH:\n\n'
Expand Down