burrow

KO | EN

gitlite — search

#javascript #ai #typescript #llm #golang #rust #deep-learning #linux #docker #nodejs #cli #awesome-list #security #openai

(★ 20)

A macOS TUI for SSH port-forwarding tunnels — a daemon keeps them alive and auto-reconnects.

burrow 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">burrow</h1>

<p align="center">A focused terminal dashboard for reliable SSH port-forwarding tunnels on macOS and Linux.</p>

`burrow` turns repetitive `ssh -N -L ...` commands into a small, observable control plane. Configure tunnels once, start or stop them from a TUI, and let a background daemon reconnect them when the network gets flaky.

## Highlights

- Multiple named SSH tunnels backed by your existing `~/.ssh/config`.
- Live status, PID, restart count, uptime, TCP reachability, and stderr logs.
- Keepalive with exponential backoff and daemon restart reclaiming.
- Safe failure when a local port is already occupied.
- No passwords or private keys are stored by this project; authentication stays with OpenSSH.

## Install

### One-line installer (recommended)

```bash
curl -fsSL https://raw.githubusercontent.com/cjraft/burrow/main/dist/install.sh | bash
```

The installer detects the operating system and architecture, downloads the matching GitHub Release archive, installs `burrow`, and creates the shortest available launcher name. It prefers `bw`; if `bw` is already occupied by a command, alias, function, or builtin, it tries `burrow`, then `burrow-tui` instead. Set `BURROW_VERSION=v0.1.0` to install a specific release.

> Prebuilt releases currently support Apple Silicon macOS and x86_64 Linux. Intel Macs and Linux ARM machines can build from source.

After installation:

```bash
bw                 # or the launcher name printed by the installer
```

If the installer says the directory is not in `PATH`, add the printed line to `~/.zshrc` and open a new terminal.

## Quick start

1. Add a host to `~/.ssh/config` and verify it first:

```bash
   ssh cj 'echo ok'
   ```

2. Start the app with `bw`.
3. Press `a` and create a tunnel, for example:
   - name: `cj-mongo`
   - SSH host: `cj`
   - local port: `27017`
   - remote host: `127.0.0.1`
   - remote port: `27017`
4. Select it and press `s`. A green `Connected` status means the local forward is ready.

## Controls

| Key | Action |
| --- | --- |
| `↑` / `↓`, `j` / `k` | Select a tunnel |
| `s` / `x` / `r` | Start / stop / restart |
| `a` / `e` / `d` | Add / edit / delete |
| `Enter` | Details and SSH stderr |
| `q` / `Ctrl-C` | Exit TUI; daemon and tunnels stay alive |
| `Q` | Stop daemon and all tunnels |

## Requirements

- macOS on Apple Silicon (arm64), or Linux on x86_64, for prebuilt releases
- OpenSSH (`ssh`)
- A working SSH host alias in `~/.ssh/config`; the app uses `BatchMode=yes`

## Configuration

Configuration and daemon runtime files live under the platform configuration directory:

```text
# macOS
~/Library/Application Support/burrow/

# Linux (or $XDG_CONFIG_HOME/burrow)
~/.config/burrow/

├── tunnels.toml
├── daemon.sock
└── daemon.pid
```

Example `tunnels.toml`:

```toml
[[tunnel]]
name = "cj-mongo"
ssh_host = "cj"
local_port = 27017
remote_host = "127.0.0.1"
remote_port = 27017
keepalive = true
autostart = false
```

## Build from source

```bash
# Install Rust with rustup, or use your package manager.
cargo build --release
./target/release/burrow
```

Build a distributable archive:

```bash
./scripts/package.sh
```

## Uninstall

```bash
# Stop all tunnels first by pressing Q in the app
rm -f "$(command -v burrow 2>/dev/null || true)"
rm -f "$HOME/.local/bin/bw" "$HOME/.local/bin/burrow" "$HOME/.local/bin/burrow-tui"
rm -rf "$HOME/Library/Application Support/burrow" # macOS
rm -rf "${XDG_CONFIG_HOME:-$HOME/.config}/burrow" # Linux
```

## Security notes

`burrow` delegates authentication to your local OpenSSH configuration. It does not implement or collect credentials. Managed SSH processes carry a private marker so the daemon can reclaim only its own tunnels after a restart.

## Contributing

Issues and pull requests are welcome. Please include operating system, architecture, Rust version, reproduction steps, and relevant SSH stderr when reporting a problem.

## License

MIT. See [`LICENSE`](LICENSE).

burrow

burrow 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

burrow

burrow 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README