Skip to content

docs: give Windows a working install command - #4

Open
Abdul-Omira wants to merge 1 commit into
mainfrom
fix/windows-powershell-install
Open

docs: give Windows a working install command#4
Abdul-Omira wants to merge 1 commit into
mainfrom
fix/windows-powershell-install

Conversation

@Abdul-Omira

Copy link
Copy Markdown
Collaborator

Companion to aixplain/aixplainCode#754, which adds install.ps1 to the release. This is the page customers actually read.

What's wrong today

The Install section offers one command — curl -fsSL … | bash — and the platform badge advertises Windows. A Windows user pastes the only thing on offer and it cannot work. Reproduced both variants on Windows 11 / PowerShell 5.1:

Machine Failure
No WSL/Git Bash The term 'bash' is not recognized
WSL present Invoke-WebRequest : A parameter cannot be found that matches parameter name 'fsSL'

The second is the common one: PowerShell 5.1 aliases curl to Invoke-WebRequest, so it dies on the flags before bash is even reached.

Platform support then says:

On Windows, download koder-windows-x64.tar.gz … the shell installer above is for macOS and Linux.

That's false. install has detected MINGW*|MSYS*|CYGWIN* and installed koder.exe for months. What it genuinely cannot do is run outside a bash, or write a PATH entry that PowerShell and cmd can see — it writes to ~/.bashrc. So even a successful Git Bash install leaves koder "not found" in PowerShell.

This PR

  • Adds the PowerShell one-liner to Install, plus the [scriptblock]::Create form for -Version / -NoModifyPath (a piped iex has nowhere to put options).
  • Rewrites the Platform support paragraph to say what's actually true, keeping the manual tarball download as the fallback rather than the recommendation.

Merge order

install.ps1 is published by aixplain/aixplainCode#754, so merge that first and cut a release — until then the install.ps1 URL 404s. #754 also adds a check that fails our sync job if this README ever stops teaching an installer we publish, which is how the wrong paragraph survived this long.

The Install section offered only `curl … | bash`, which cannot work in
PowerShell — the shell Windows users get. It fails with "the term 'bash' is
not recognized", or, where WSL is installed, with "Invoke-WebRequest: A
parameter cannot be found that matches parameter name 'fsSL'", because
PowerShell 5.1 aliases curl to Invoke-WebRequest. Both reproduced on
Windows 11 / PowerShell 5.1.

Adds the PowerShell one-liner, and the scriptblock form for passing options.

Platform support also claimed "the shell installer above is for macOS and
Linux" and sent Windows users to a manual tarball download. That was wrong:
`install` has handled Windows for months. What it cannot do is run outside a
bash, or put koder on a PATH that PowerShell and cmd can see — which is what
install.ps1 is for. Says that instead, and keeps the manual download as the
fallback it is.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant