Skip to content
Merged
34 changes: 34 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -368,3 +368,37 @@ jobs:
fi
env:
GH_TOKEN: ${{ secrets.HOMEBREW_TAP_TOKEN }}

winget:
name: Update winget manifest
needs: [release]
if: ${{ !inputs.prerelease }}
runs-on: ubuntu-latest
Comment thread
kerta1n marked this conversation as resolved.
# A failed submission must not fail the release workflow: cd.yml gates
# update-latest-tag on build-release, so a red job here would leave the
# 'latest' tag on the previous version.
continue-on-error: true
steps:
- name: Get version
id: version
env:
INPUT_TAG: ${{ inputs.tag }}
RELEASE_TAG: ${{ github.event.release.tag_name }}
run: |
TAG="$INPUT_TAG"
if [ -z "$TAG" ]; then
TAG="$RELEASE_TAG"
fi
VERSION="${TAG#v}"
echo "tag=$TAG" >> $GITHUB_OUTPUT
echo "version=$VERSION" >> $GITHUB_OUTPUT

# Pinned to a main commit, not the v2 tag: v2 has not moved since 2024-11-27
# and is four fixes behind, including cargo binstall on ubuntu-slim runners.
- uses: vedantmgoyal9/winget-releaser@a43926ed822e5a076ac8a81e0a794915cbad51d1 # 2026-03-14
with:
identifier: rtk-ai.rtk
version: ${{ steps.version.outputs.version }}
installers-regex: 'rtk-x86_64-pc-windows-msvc\.zip$'
token: ${{ secrets.WINGET_TOKEN }}
release-tag: ${{ steps.version.outputs.tag }}
7 changes: 7 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,12 @@ After installation, **verify you have the correct rtk**:
rtk gain # Must show the savings dashboard (not "command not found")
```

### Quick Install (Windows)

```powershell
winget install rtk-ai.rtk
```

### Alternative: Manual Installation

```bash
Expand Down Expand Up @@ -265,6 +271,7 @@ cargo uninstall rtk

# If installed via package manager
brew uninstall rtk # macOS Homebrew
winget uninstall rtk-ai.rtk # Windows winget
sudo apt remove rtk # Debian/Ubuntu
sudo dnf remove rtk # Fedora/RHEL
```
Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,14 @@ The token counts RTK reports are estimated as `bytes / 4` — RTK ships no token
brew install rtk
```

### winget (Windows)

Easiest way to install on Windows — one command, no PATH setup needed:

```powershell
winget install rtk-ai.rtk
```

### Quick Install (Linux/macOS)

```bash
Expand Down Expand Up @@ -363,7 +371,9 @@ By default `RTK.md` says nothing about RTK itself. Set `[awareness] level = "hig

RTK works fully on native Windows. Since **v0.37.2** the auto-rewrite hook runs as a **native binary command** (`rtk hook claude`) — no Unix shell, bash, or jq required — so commands are rewritten transparently on Command Prompt, PowerShell, and Windows Terminal, just like on Linux and macOS.

### Native Windows
### Native Windows (manual install)

Prefer [`winget`](#winget-windows) if you can — it handles PATH for you.

```powershell
# 1. Download and extract rtk-x86_64-pc-windows-msvc.zip from releases
Expand Down
8 changes: 8 additions & 0 deletions README_es.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ Los recuentos de tokens que reporta RTK se estiman como `bytes / 4`: RTK no incl
brew install rtk
```

### winget (Windows)

La forma mas facil de instalar en Windows — un solo comando, sin configuracion de PATH:

```powershell
winget install rtk-ai.rtk
```

### Instalacion rapida (Linux/macOS)

```bash
Expand Down
8 changes: 8 additions & 0 deletions README_fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ Les nombres de tokens rapportes par RTK sont estimes avec `octets / 4` : RTK n'e
brew install rtk
```

### winget (Windows)

La manière la plus simple d'installer sur Windows — une seule commande, aucune modification de PATH requise :

```powershell
winget install rtk-ai.rtk
```

### Installation rapide (Linux/macOS)

```bash
Expand Down
8 changes: 8 additions & 0 deletions README_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ RTK が報告するトークン数は `バイト数 / 4` で見積もられて
brew install rtk
```

### winget(Windows)

Windowsで最も簡単なインストール方法 — コマンド1つ、PATHの設定不要:

```powershell
winget install rtk-ai.rtk
```

### クイックインストール(Linux/macOS)

```bash
Expand Down
8 changes: 8 additions & 0 deletions README_ko.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ RTK가 보고하는 토큰 수는 `바이트 / 4`로 추정됩니다. RTK에는
brew install rtk
```

### winget (Windows)

Windows에서 가장 쉬운 설치 방법 — 명령어 하나로 끝, PATH 설정 불필요:

```powershell
winget install rtk-ai.rtk
```

### 빠른 설치 (Linux/macOS)

```bash
Expand Down
8 changes: 8 additions & 0 deletions README_pt.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,14 @@ As contagens de tokens que o RTK reporta são estimadas como `bytes / 4`: o RTK
brew install rtk
```

### winget (Windows)

A forma mais simples de instalar no Windows — um único comando, sem configuração de PATH:

```powershell
winget install rtk-ai.rtk
```

### Instalação rápida (Linux/macOS)

```bash
Expand Down
8 changes: 8 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ RTK 报告的 token 数量按 `字节数 / 4` 估算:RTK 不内置分词器,
brew install rtk
```

### winget(Windows)

Windows 上最简单的安装方式 — 一条命令,无需配置 PATH:

```powershell
winget install rtk-ai.rtk
```

### 快速安装(Linux/macOS)

```bash
Expand Down
9 changes: 8 additions & 1 deletion docs/guide/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Installation
description: Install RTK via curl, Homebrew, Cargo, or from source, and verify the correct version
description: Install RTK via curl, Homebrew, winget, Cargo, or from source, and verify the correct version
sidebar:
order: 1
---
Expand Down Expand Up @@ -37,6 +37,12 @@ curl -fsSL https://raw.githubusercontent.com/rtk-ai/rtk/master/install.sh | sh
brew install rtk-ai/tap/rtk
```

## winget (Windows)

```powershell
winget install rtk-ai.rtk
```

## Cargo

:::caution[Name collision risk]
Expand Down Expand Up @@ -92,4 +98,5 @@ rtk init --global
rtk init -g --uninstall # remove hook, RTK.md, and settings.json entry
cargo uninstall rtk # remove binary (if installed via Cargo)
brew uninstall rtk # remove binary (if installed via Homebrew)
winget uninstall rtk-ai.rtk # remove binary (if installed via winget)
```
Loading