BitBang CLI

bitbang は、単一の静的バイナリで動作するリモートアクセス多機能ツールです。任意のブラウザから、リモートマシンへの対話型シェルとファイルブラウザアクセスを提供します。また、そのマシンのネットワーク上のWebアプリにもアクセスできます。ブラウザ以外にも、TCPポートフォワーディング、ファイルコピー、ターミナル共有に対応しています。アカウントや設定は不要で、そのまま動作します。

アクセスしたいマシン上で:``` curl -sSfL bitba.ng/install | sh bitbang serve

`serve` は URL を出力します。任意のブラウザで開くと、ターミナル、ファイルブラウザ、そのマシンのネットワークへのプロキシが表示されます。あるいは、別のターミナルから `bitbang connect <url>` で同じマシンに到達でき、ポートフォワーディング (`-L`) とファイルコピー (`bitbang cp`) が追加されます。接続はエンドツーエンドで暗号化され、ピアツーピアです。`bitba.ng` サーバーは両端を紹介するだけで、その後は関与しません。

`bitbang` は単一の静的 Go バイナリです。[BitBang プロジェクト](https://github.com/richlegrand/bitbang) の一部であり、この[ホワイトペーパー](https://github.com/richlegrand/bitbang/blob/main/whitepaper.md) で設計が詳しく説明されています。

## 比較

|                                | ngrok                  | Tailscale                      | `bitbang`           |
| ------------------------------ | ---------------------- | ------------------------------ | ------------------- |
| 初回使用前のセットアップ         | アカウント + authtoken | 各デバイスでアカウント + ログイン | **コマンドを 1 つ実行** |
| 何かを共有するために実行するもの | Web サーバー + ngrok   | 両方のマシンでクライアントを実行 | **`bitbang serve`** |
| 遠端のブラウザが受け取るもの     | すでに実行していた Web サーバー | なし -- クライアントが必要 | **リモートネットワーク上のターミナル、ファイルブラウザ、Web アプリ** |
| データ経路                      | 自社サーバー           | P2P (リレーフォールバック)      | **P2P (リレーフォールバック)** |
| エンドツーエンド暗号化           | デフォルトではなし     | あり                            | **あり**             |

## クイックレシピ

**自宅のサービスにアクセス**

- [どこからでも自宅の NAS をマウント (SMB)](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#mount-your-home-nas-from-anywhere-smb)
- [どこからでもメディアライブラリを視聴 (Jellyfin)](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#watch-your-media-library-from-anywhere-jellyfin)
- [どこからでも独自の LLM を使用 (Ollama、Open WebUI)](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#use-your-own-llm-from-anywhere-ollama-open-webui)
- [防犯カメラを確認 (Frigate)](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#check-your-security-cameras-frigate)
- [ホームオートメーションを公開せずにアクセス (Home Assistant)](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#reach-your-home-automation-without-exposing-it-home-assistant)
- [自宅のプリンターに印刷 (IPP、CUPS)](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#print-to-your-home-printer-ipp-cups)

**マシンにアクセス**

- [NAT の背後にあるマシンでシェルを取得](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#get-a-shell-on-a-machine-behind-nat)
- [スマートフォンからシェルを取得](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#get-a-shell-from-your-phone)
- [Windows マシンにリモートデスクトップ接続 (RDP)](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#remote-desktop-into-a-windows-machine-rdp)
- [Linux または Mac のデスクトップにアクセス (VNC)](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#reach-a-linux-or-mac-desktop-vnc)
- [ポートを開いていないマシンに SSH 接続 (OpenSSH)](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#ssh-to-a-machine-with-no-open-port-openssh)
- [ヘッドレス Raspberry Pi をセットアップ](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#set-up-a-headless-raspberry-pi)

**他の人と共有**

共有とは、単にアクセスを許可する一意の URL または QR コードを誰かに渡すことです。権限は調整でき、数分、数時間などで期限切れに設定できます。

- [ファイルをどこにもアップロードせずに共有](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#share-files-without-uploading-them-anywhere)
- [プロジェクトを誰かに見せる](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#show-someone-your-project)
- [期限付きのアクセスを誰かに付与](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#give-someone-access-that-expires)
- [スマートフォンからエージェントセッションを確認 (Claude Code、tmux)](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#check-your-agent-session-from-your-phone-claude-code-tmux)
- [他の人のルーターを修理](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#fix-someone-elses-router)

**開発とデバイス**

- [開発マシンからデータベースにアクセス (Postgres、MySQL)](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#reach-a-database-from-your-dev-machine-postgres-mysql)
- [互いを見つけられないデバイスを同期 (Syncthing)](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#sync-devices-that-cannot-find-each-other-syncthing)
- [ブラウザからロボットを監視 (ROS、Foxglove)](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#watch-a-robot-from-a-browser-ros-foxglove)

**テクニック**

- [フォワーディングリスナーが公開するもの](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#what-a-forwarding-listener-exposes)
- [LAN 上の他のマシンにフォワードを使用させる](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#let-other-machines-on-your-lan-use-a-forward)
- [動作しないことが判明しているもの](https://github.com/richlegrand/bitbang/blob/main/cookbook.md#known-not-to-work)

## `bitbang` の使用

すべての接続には 2 つの端があります。**リスナー** (到達されるマシン上で実行される `bitbang serve`) と**コネクター** (到達するマシン上のブラウザ、または `bitbang` CLI) です。1 つのリスナー URL が両方の種類のコネクターにサービスを提供します。

### リスナー: `bitbang serve````
bitbang serve                    # everything: shell + proxy + files + forward
bitbang serve shell              # just a terminal
bitbang serve files ~/share      # just a directory (-files-upload to allow uploads)
bitbang serve proxy localhost:8080       # just one web app, straight at the URL
bitbang serve proxy a.lan:80,b.lan:80    # ...or several, chosen in the browser
bitbang serve forward 127.0.0.1:22       # just TCP, for `connect -L`

bitbang serve shell files ~/share proxy nas.lan:8096   # any combination

各モードはQRコード、URL、ペアリングコードを出力します。モードによってリスナーが実行できることが決まります。serve shell には付与する転送がなく、転送専用リスナーはシェルを起動しないため、権限昇格の対象となるものはありません。

知っておくべきデフォルトの1つ: 転送とプロキシは、リスナーが到達できる任意のホスト:ポートに到達します。意図したホストだけではありません。そのため、データベース用に配布したリンクは、そのネットワークの他の部分にも到達します。ターゲットを単語で指定すると範囲が狭まります -- forward db.internal:5432 はそのホストにのみ到達し、他には到達しません。

実行中のセッションを共有: bitbang share

serve shell は新しいシェルを起動します。share はすでに実行中のtmuxセッションを公開します:``` bitbang share # publish the current tmux session bitbang share --read-only # publish without a control URL bitbang share status|stop|rotate

コマンドは公開後に戻るため、進行中のタスクには`Ctrl-Z`、`bitbang share`、`fg`が機能します。ホスティングにはUnixまたはWSL上のtmux 3.2+が必要です。ネイティブWindowsクライアントはURLを開けますが、シェアをホストすることはできません。

デフォルトでは、コマンドは2つのベアラURLを出力します:

- **コントロールURL**は、ローカルキーボードと同じ権限で入力できます。一度に接続できるコントローラは1つです。
- **ビューURL**は閲覧専用です。入力はtmuxに到達する前に破棄され、最大`--max-viewers`人のビューアが同時に接続できます（デフォルトは16）。

`--read-only`はコントロール資格情報を完全に省略します。ビューアとコントローラの制限は、シェルを開く前であっても、各接続の存続期間中保持されます。

シェアはデフォルトで停止されるまで実行されます。`--ttl`は存続期間を設定します（例: `--ttl 1h`）。シェアURLは一時的なもので、`devices.json`に保存されることはありません。`share stop`、TTLの期限切れ、またはソースセッションの削除により、ソースセッションを停止せずにリモートピアが切断されます。

`bitbang share`を再実行すると、実行中のシェアのURLが再表示されます。実行中の設定と矛盾するフラグを渡した場合（たとえば、コントロールURLを持つシェアに対して`--read-only`を指定した場合）、古いURLを返すのではなく、その旨が通知されます。`bitbang share rotate`は、新しいフラグを使用するシェアに置き換えます。

バックグラウンドワーカーは、デタッチされた`_bbshare_*` tmux管理セッションで実行されるため、管理するデーモンやPIDファイルはありません。

共有によってtmuxオプションが変更されることはありません。tmuxのデフォルトの`window-size latest`では、ウィンドウはアクティブな読み書きクライアントに追従します。単独のビューアでも、利用可能な唯一のサイズが提供されます。`window-size`が上書きされている場合、`share`はそれを報告しますが、ユーザーの設定は変更しません。

### 制限付きアクセスの配布: `bitbang link`