Skip to content

docs: give Windows a working install command #4

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

Open
Abdul-Omira wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: give Windows a working install command #4

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
33 changes: 30 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,23 @@ tools, and works against the models in your aixplain account.

## Install

macOS and Linux:

```sh
curl -fsSL https://github.com/aixplain/koder/releases/latest/download/install | bash
```

Windows, in PowerShell:

```powershell
irm https://github.com/aixplain/koder/releases/latest/download/install.ps1 | iex
```

> Don't paste the `curl … | bash` line into PowerShell. `bash` isn't a Windows
> command, and PowerShell 5.1 aliases `curl` to `Invoke-WebRequest`, which rejects
> `-fsSL`. Use the PowerShell line above — it also puts `koder` on your PATH for
> PowerShell, cmd and Windows Terminal, which a Git Bash install cannot do.

Open a new terminal afterwards, then run `koder` from inside a project:

```sh
Expand All @@ -54,6 +67,14 @@ curl -fsSL https://github.com/aixplain/koder/releases/latest/download/install |
curl -fsSL https://github.com/aixplain/koder/releases/latest/download/install | bash -s -- --no-modify-path
```

The same, in PowerShell. A piped `iex` has nowhere to put options, so the script
has to be materialised first:

```powershell
& ([scriptblock]::Create((irm https://github.com/aixplain/koder/releases/latest/download/install.ps1))) -Version 0.3.1
& ([scriptblock]::Create((irm https://github.com/aixplain/koder/releases/latest/download/install.ps1))) -NoModifyPath
```

## First run

Koder asks for an aixplain API key the first time it starts.
Expand Down Expand Up @@ -193,9 +214,15 @@ curl -fsSL https://github.com/aixplain/koder/releases/latest/download/install |
| Linux | x64, arm64 |
| Windows | x64 |

macOS 12 or later. On Windows, download `koder-windows-x64.tar.gz` from the
[releases page](https://github.com/aixplain/koder/releases/latest) and put `koder.exe`
somewhere on your PATH; the shell installer above is for macOS and Linux.
macOS 12 or later. On Windows, use the PowerShell installer in [Install](#install) —
it puts `koder.exe` in `~/.koder/bin` and adds that to your user PATH, so `koder`
works in PowerShell, cmd and Windows Terminal.

The `curl … | bash` installer also supports Windows, but only from inside Git Bash
or WSL, and the PATH entry it writes is visible only to that shell. You can always
download `koder-windows-x64.tar.gz` from the
[releases page](https://github.com/aixplain/koder/releases/latest) and place
`koder.exe` on your PATH by hand instead.

## Verifying a download

Expand Down