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
11 changes: 9 additions & 2 deletions README.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,15 @@ estático, **sin dependencias externas** — solo la biblioteca estándar.
brew install sadgoodman/tap/cli-proxy
```

Descarga un archivo precompilado desde la [última versión][rel], o compílalo
desde el código fuente con Go 1.25+.
En Windows, con [Scoop](https://scoop.sh) — no hace falta ser administrador:

```powershell
scoop bucket add sadgoodman https://github.com/sadgoodman/scoop-bucket
scoop install cli-proxy
```

En cualquier otro caso, descarga un archivo precompilado desde la
[última versión][rel] o compílalo desde el código fuente con Go 1.25+.

| Plataforma | Artefacto |
|---|---|
Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,15 @@ dependencies** — standard library only.
brew install sadgoodman/tap/cli-proxy
```

Download a prebuilt archive from the [latest release][rel], or build from
source with Go 1.25+.
On Windows, with [Scoop](https://scoop.sh) — no administrator rights needed:

```powershell
scoop bucket add sadgoodman https://github.com/sadgoodman/scoop-bucket
scoop install cli-proxy
```

Anywhere else, download a prebuilt archive from the [latest release][rel], or
build from source with Go 1.25+.

| Platform | Asset |
|---|---|
Expand Down
11 changes: 9 additions & 2 deletions README.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,15 @@
brew install sadgoodman/tap/cli-proxy
```

Скачайте готовый архив из [последнего релиза][rel] или соберите из исходников
(нужен Go 1.25+).
На Windows — через [Scoop](https://scoop.sh), права администратора не нужны:

```powershell
scoop bucket add sadgoodman https://github.com/sadgoodman/scoop-bucket
scoop install cli-proxy
```

В остальных случаях скачайте готовый архив из [последнего релиза][rel] или
соберите из исходников (нужен Go 1.25+).

| Платформа | Файл |
|---|---|
Expand Down
9 changes: 8 additions & 1 deletion README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,14 @@
brew install sadgoodman/tap/cli-proxy
```

从[最新发布][rel]下载预编译压缩包,或使用 Go 1.25+ 从源码构建。
Windows 上使用 [Scoop](https://scoop.sh),无需管理员权限:

```powershell
scoop bucket add sadgoodman https://github.com/sadgoodman/scoop-bucket
scoop install cli-proxy
```

其他情况请从[最新发布][rel]下载预编译压缩包,或使用 Go 1.25+ 从源码构建。

| 平台 | 资源文件 |
|---|---|
Expand Down
48 changes: 43 additions & 5 deletions docs/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,35 @@ dependencies** — the Go standard library only.

## Installing

Homebrew is the shortest route:
`cli-proxy` is a single static binary, so there is no installer to run and
nothing to uninstall. Pick whichever package manager you already use, or take
the archive and put the binary wherever you like.

### macOS and Linux

```sh
brew install sadgoodman/tap/cli-proxy
```

Otherwise download a prebuilt archive from the [latest release][rel]:
### Windows

Scoop needs no administrator rights:

```powershell
scoop bucket add sadgoodman https://github.com/sadgoodman/scoop-bucket
scoop install cli-proxy
```

Then `scoop update cli-proxy` and `scoop uninstall cli-proxy` manage it. The
manifest covers both x86-64 and arm64 Windows.

The first time the proxy binds to `0.0.0.0`, Windows Defender Firewall asks
whether to allow it on private networks — say yes if you want to intercept
traffic from a phone or another machine.

### Everything else

Download a prebuilt archive from the [latest release][rel]:

| Platform | Asset |
|---|---|
Expand All @@ -90,9 +112,21 @@ Otherwise download a prebuilt archive from the [latest release][rel]:

`checksums.txt` in the same release carries the SHA-256 of every archive.

The Homebrew formula updates itself: [`sadgoodman/homebrew-tap`][tap] is checked
against the latest release every hour. To pick a release up immediately, run the
**Update formulae** workflow from the Actions tab.
Unpack it and put `cli-proxy` (or `cli-proxy.exe`) somewhere on your `PATH`.
The archives are plain files, not installers: no registry entries, no services.

### Keeping the packages current

Both the Homebrew formula and the Scoop manifest update themselves.
[`sadgoodman/homebrew-tap`][tap] and [`sadgoodman/scoop-bucket`][scoop] are
checked against the latest release every hour. To pick a release up
immediately, run the **Update formulae** or **Update manifests** workflow from
the corresponding repository's Actions tab.

There is no Chocolatey package and no winget manifest yet. Chocolatey would
require administrator rights on every install and a moderated community review,
which buys little for a single binary; winget needs the manifests merged into
`microsoft/winget-pkgs` first.

## Building

Expand Down Expand Up @@ -615,3 +649,7 @@ on the fly (including refusing a busy port and preserving flows), parsing
keyboard escape sequences and SGR mouse events, the geometry of the rounded
tables, full rendering of every screen, button availability at any width, and
mouse handling.

[rel]: https://github.com/sadgoodman/cli-proxy/releases/latest
[tap]: https://github.com/sadgoodman/homebrew-tap
[scoop]: https://github.com/sadgoodman/scoop-bucket
48 changes: 43 additions & 5 deletions docs/guide.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,35 @@

## Установка

Через Homebrew — короче всего:
`cli-proxy` — один статический бинарник: установщика нет и удалять потом
нечего. Выбирайте привычный пакетный менеджер или просто возьмите архив и
положите программу куда удобно.

### macOS и Linux

```sh
brew install sadgoodman/tap/cli-proxy
```

Или скачайте готовый архив из [последнего релиза][rel]:
### Windows

Scoop не требует прав администратора:

```powershell
scoop bucket add sadgoodman https://github.com/sadgoodman/scoop-bucket
scoop install cli-proxy
```

Дальше `scoop update cli-proxy` и `scoop uninstall cli-proxy`. Манифест покрывает
и x86-64, и arm64.

При первой привязке к `0.0.0.0` брандмауэр Windows спросит, разрешить ли
программе доступ в частных сетях — согласитесь, если хотите перехватывать
трафик с телефона или другой машины.

### Всё остальное

Скачайте готовый архив из [последнего релиза][rel]:

| Платформа | Файл |
|---|---|
Expand All @@ -86,9 +108,21 @@ brew install sadgoodman/tap/cli-proxy

В том же релизе лежит `checksums.txt` с SHA-256 каждого архива.

Формула Homebrew обновляется сама: репозиторий [`sadgoodman/homebrew-tap`][tap]
раз в час сверяется с последним релизом. Если нужно сразу после выпуска,
запустите workflow **Update formulae** во вкладке Actions.
Распакуйте и положите `cli-proxy` (или `cli-proxy.exe`) куда-нибудь в `PATH`.
Это обычные файлы, а не установщик: ни записей в реестре, ни служб.

### Как обновляются пакеты

И формула Homebrew, и манифест Scoop обновляются сами.
[`sadgoodman/homebrew-tap`][tap] и [`sadgoodman/scoop-bucket`][scoop] раз в час
сверяются с последним релизом. Если нужно сразу после выпуска, запустите
workflow **Update formulae** или **Update manifests** во вкладке Actions
соответствующего репозитория.

Пакета для Chocolatey и манифеста winget пока нет. Chocolatey потребовал бы
прав администратора при каждой установке и модерации в общем репозитории, что
для одного бинарника мало что даёт; winget требует, чтобы манифесты сначала
попали в `microsoft/winget-pkgs`.

## Сборка

Expand Down Expand Up @@ -598,3 +632,7 @@ go test ./...
на лету (включая отказ при занятом порте и сохранение потоков), разбор
escape-последовательностей клавиатуры и SGR-мыши, геометрия скруглённых таблиц,
полная отрисовка всех экранов, доступность кнопок на любой ширине и реакция на мышь.

[rel]: https://github.com/sadgoodman/cli-proxy/releases/latest
[tap]: https://github.com/sadgoodman/homebrew-tap
[scoop]: https://github.com/sadgoodman/scoop-bucket
Loading