Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Fixed

- Document the Windows PowerShell installation path, including Bun's native installer and the `bun.exe` requirement for npm launchers.
- Stop queries that run longer than 6 minutes from failing with `Request failed (network error): … (The operation timed out.)`. `--read-timeout` is now the only limit on query streams, and `0` means no limit.

- Keep the TypeScript manifest compiler out of CLI downloads by installing it with the cached single-file preview runtime.
Expand Down
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ altertable query "SELECT id, email, plan FROM analytics.main.users LIMIT 10"

### Install script

Recommended for most users:
Recommended for macOS and Linux:

```bash
curl -fsSL https://install.altertable.ai | sh
Expand All @@ -74,6 +74,31 @@ npm install -g @altertable/cli

Requires [Bun](https://bun.sh) at runtime (used as the JS engine when running the npm package). You can also install the same package with `bun install -g @altertable/cli`.

### Windows (PowerShell)

Install Bun with its [Windows installer](https://bun.sh/docs/installation), then install the CLI with npm:

```powershell
irm https://bun.sh/install.ps1 | iex
```

Close and reopen PowerShell so the updated `PATH` is loaded, then run:

```powershell
Get-Command bun.exe
bun --version
npm install -g @altertable/cli
altertable --version
```

The npm CLI requires `bun.exe` on `PATH`; Node.js cannot run the CLI bundle.
Installing Bun with `npm install -g bun` can provide only npm's `bun.cmd` and
`bun.ps1` shims on `PATH`, which the CLI's generated PowerShell launcher cannot
use in place of `bun.exe`. Use Bun's Windows installer instead.

The shell install script and the prebuilt binaries below are currently for macOS
and Linux, not Windows. Windows users should use the npm installation above.

### Prebuilt binaries

Download the platform binary from [GitHub Releases](https://github.com/altertable-ai/altertable-cli/releases). Each release ships:
Expand Down
Loading