sshler 0.3.3__tar.gz → 0.4.0__tar.gz

{sshler-0.3.3/sshler.egg-info → sshler-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sshler
-Version: 0.3.3
+Version: 0.4.0
 Summary: A local FastAPI-powered SSH multiplexer for tmux-in-browser — from your laptop only.
 Author: You
 License-Expression: MIT
@@ -91,12 +91,10 @@ sshler serve
 
 The app will open `http://127.0.0.1:8822` in your default browser.
 
-## Configuration / 設定
+## Configuration
 
 sshler reads your existing OpenSSH config (`~/.ssh/config`) and shows every concrete `Host` entry automatically. Any favourites, default directories, or custom hosts you add through the UI are stored in a companion YAML file.
 
-- **日本語:** OpenSSH の設定 (`~/.ssh/config`) を読み取り、すべての `Host` が自動的に一覧に表示されます。お気に入りやデフォルトディレクトリ、カスタムホストは付属の YAML に保存されます。
-
 A config file is created on first run:
 
 - Windows: `%APPDATA%\sshler\boxes.yaml`
@@ -119,27 +117,21 @@ boxes:
     default_dir: /home/gabu
 ```
 
-> Tip: Set `default_dir` if your home path isn’t `/home/<user>`.
+> Tip: Set `default_dir` if your home path isn't `/home/<user>`.
 > If you rely on an OpenSSH alias, add `ssh_alias:` and sshler will run `ssh -G` to expand it when DNS fails.
 
-- **日本語のヒント:** ホームディレクトリが `/home/<user>` 以外なら `default_dir` を設定してください。OpenSSH のエイリアスを利用する場合は `ssh_alias:` を追加すると、DNS 失敗時に `ssh -G` で解決します。
-
-### Resetting overrides / 上書き設定のリセット
-
-Boxes imported from SSH config show a highlighted border and “Refresh” button. If you change something in `~/.ssh/config`, hit Refresh to drop any stored overrides (host/user/port/key) so the new settings take effect without editing `boxes.yaml`.
-
-- **日本語:** SSH 設定から取り込まれたボックスは枠が強調表示され、「Refresh」ボタンで上書き設定を削除できます。`~/.ssh/config` を更新した際はボタンを押すだけで最新状態になります。
+### Resetting overrides
 
-### Adding custom boxes / カスタムボックスの追加
+Boxes imported from SSH config show a highlighted border and "Refresh" button. If you change something in `~/.ssh/config`, hit Refresh to drop any stored overrides (host/user/port/key) so the new settings take effect without editing `boxes.yaml`.
 
-Hit “Add Box” in the UI to define a host that isn’t in your SSH config (for example, a throwaway Docker container). Fields you leave blank fall back to your SSH defaults.
+### Adding custom boxes
 
-- **日本語:** UI の “Add Box” から SSH 設定に存在しないホストも追加できます（例: 一時的な Docker コンテナ）。未入力の項目は SSH のデフォルト値が使われます。
+Hit "Add Box" in the UI to define a host that isn't in your SSH config (for example, a throwaway Docker container). Fields you leave blank fall back to your SSH defaults.
 
 ### Security model (important)
 
 - sshler is designed for **single-user localhost** use. By default `sshler serve` binds to `127.0.0.1` and prints a random `X-SSHLER-TOKEN` that every state-changing request must send.
-- File uploads are capped at 50 MB (tunable via `--max-upload-mb`). Uploaded content is never executed server-side.
+- File uploads are capped at 50 MB (tunable via `--max-upload-mb`). Uploaded content is never executed server-side.
 - SSH connections still honour your system `known_hosts`. Only set `known_hosts: ignore` if you fully understand the risk.
 - If you expose sshler beyond localhost, opt-in via `--allow-origin` and add `--auth user:pass` (basic auth). Use it only on networks you trust and put TLS in front (nginx, Caddy, etc.).
 - There is no telemetry, analytics, or call-home behaviour.
@@ -168,8 +160,6 @@ sshler serve \
 
 The server prints the token (and, if enabled, the basic auth username) on startup so you can copy it into API clients or browser extensions.
 
-- **日本語:** サーバー起動時にトークン（および Basic 認証を有効にした場合はユーザー名）を表示するので、API クライアントやブラウザ拡張に貼り付けて利用できます。
-
 ### Terminal notifications
 
 - Send a bell (`printf '\a'`) from tmux or your shell to flash the browser title and raise a desktop notification whenever the sshler tab is hidden.
@@ -177,19 +167,15 @@ The server prints the token (and, if enabled, the basic auth username) on startu
 - JSON payloads are also supported: `printf '\033]777;notify={"title":"Codex","message":"All tasks finished"}\a'`.
 - The first notification prompts the browser for permission. Denying it still leaves the in-app toast and title badge when you return to the tab.
 
-- **日本語:** タブが非表示のときに `printf '\a'` でベルを送ると、ブラウザタイトルが点滅しデスクトップ通知が表示されます。`printf '\033]777;notify=タイトル|本文\a'` で任意メッセージを送信でき、JSON (`notify={"title":"...","message":"..."}`) にも対応しています。初回は通知許可のダイアログが表示されますが、拒否した場合でもタブ復帰時にトーストとタイトルのバッジで気付けます。
-
-## Autostart / 自動起動
+## Autostart
 
 ### Windows (Task Scheduler)
 
 1. Run `where sshler` to locate the installed executable (for example, `%LOCALAPPDATA%\Programs\Python\Python312\Scripts\sshler.exe`).
 2. Open **Task Scheduler → Create Task…**.
-3. Under **Triggers**, add “At log on”.
-4. Under **Actions**, choose “Start a program” and point to the `sshler.exe` path. Add arguments such as `serve --no-browser` and set **Start in** to a writable directory.
-5. Tick “Run with highest privileges” if you need WSL access, then save. sshler will now launch automatically every time you sign in.
-
-- **日本語:** Task Scheduler で「ログオン時」をトリガーにし、`sshler.exe serve --no-browser` を実行するタスクを作成すると、サインイン時に自動起動します。
+3. Under **Triggers**, add "At log on".
+4. Under **Actions**, choose "Start a program" and point to the `sshler.exe` path. Add arguments such as `serve --no-browser` and set **Start in** to a writable directory.
+5. Tick "Run with highest privileges" if you need WSL access, then save. sshler will now launch automatically every time you sign in.
 
 ### Linux / macOS (systemd user service)
 
@@ -216,9 +202,7 @@ systemctl --user daemon-reload
 systemctl --user enable --now sshler.service
 ```
 
-- **日本語:** 上記の systemd ユーザーサービスを作成し、`systemctl --user enable --now sshler.service` を実行するとサインイン時に自動起動します。
-
-### Dependencies & licenses
+## Dependencies & licenses
 
 - FastAPI, uvicorn, asyncssh, platformdirs, yaml (PyPI packages, permissive licenses)
 - HTMX (MIT) and xterm.js (MIT) are loaded from unpkg
@@ -226,8 +210,6 @@ systemctl --user enable --now sshler.service
 
 All assets are used under their respective MIT/BSD-style licenses. sshler itself ships under the MIT license.
 
-- **日本語:** 依存ライブラリはいずれも寛容なライセンス (MIT/BSD) で提供されています。sshler 本体も MIT ライセンスで配布されます。
-
 ## Why "sshler"?
 
 Because sometimes you want less VS Code, more terminal — but still in a nice browser tab.
@@ -314,6 +296,96 @@ boxes:
 
 > ヒント: ホームパスが `/home/<user>` でない場合は `default_dir` を設定してください。OpenSSH エイリアスを使用する場合は `ssh_alias:` を追加すると、DNS 失敗時に `ssh -G` で解決します。
 
+### 上書き設定のリセット
+
+SSH 設定から取り込まれたボックスは枠が強調表示され、「Refresh」ボタンで上書き設定を削除できます。`~/.ssh/config` を更新した際はボタンを押すだけで最新状態になります。
+
+### カスタムボックスの追加
+
+UI の "Add Box" から SSH 設定に存在しないホストも追加できます（例: 一時的な Docker コンテナ）。未入力の項目は SSH のデフォルト値が使われます。
+
+### セキュリティモデル（重要）
+
+- sshler は **シングルユーザー・ローカルホスト専用** に設計されています。デフォルトでは `sshler serve` は `127.0.0.1` にバインドし、すべての状態変更リクエストに必要なランダムな `X-SSHLER-TOKEN` を出力します。
+- ファイルアップロードは 50 MB まで（`--max-upload-mb` で調整可能）。アップロードされたコンテンツはサーバー側で実行されません。
+- SSH 接続はシステムの `known_hosts` を尊重します。リスクを完全に理解している場合のみ `known_hosts: ignore` を設定してください。
+- ローカルホスト以外に公開する場合は、`--allow-origin` でオプトインし、`--auth user:pass`（Basic 認証）を追加してください。信頼できるネットワークでのみ使用し、TLS（nginx、Caddy など）を前段に配置してください。
+- テレメトリ、アナリティクス、コールホーム機能は一切ありません。
+
+### CLI オプション
+
+```bash
+sshler serve \
+  --host 127.0.0.1 \
+  --port 8822 \
+  --max-upload-mb 50 \
+  --allow-origin http://workstation:8822 \
+  --auth coder:supersecret \
+  --no-ssh-alias \
+  --log-level info
+```
+
+- `--host`（別名 `--bind`）: バインドアドレスを設定（デフォルト: `127.0.0.1` でローカルホストのみ）。すべてのインターフェースに公開するには `0.0.0.0` を使用しますが、**信頼できるネットワーク上でのみ `--auth` と TLS を併用してください**。
+- `--port`: ポート番号を設定（デフォルト: `8822`）。
+- `--allow-origin`: CORS を拡張するために繰り返し使用可能。ローカルホスト以外に UI を公開する場合は `--auth` と組み合わせてください。
+- `--auth user:pass`: HTTP Basic 認証を有効化（`0.0.0.0` にバインドする場合は推奨）。
+- `--max-upload-mb`: アップロードサイズ制限を設定（デフォルト: 50 MB）。
+- `--no-ssh-alias`: DNS 失敗時の `ssh -G` フォールバックを無効化。
+- `--token`: 独自の `X-SSHLER-TOKEN` を指定（指定しない場合は安全なランダム値が生成されます）。
+- `--log-level`: uvicorn に直接渡されます（オプション: `critical`、`error`、`warning`、`info`、`debug`、`trace`）。
+
+サーバーは起動時にトークン（および有効にした場合は Basic 認証のユーザー名）を出力するので、API クライアントやブラウザ拡張機能にコピーできます。
+
+### ターミナル通知
+
+- tmux またはシェルからベル（`printf '\a'`）を送信すると、sshler タブが非表示のときにブラウザタイトルが点滅し、デスクトップ通知が表示されます。
+- より豊富なメッセージには OSC 777 を使用: `printf '\033]777;notify=Codex%20done|Check%20the%20output\a'`。`|` の前のテキストがタイトルになり、後半が本文になります。
+- JSON ペイロードもサポート: `printf '\033]777;notify={"title":"Codex","message":"All tasks finished"}\a'`。
+- 初回の通知はブラウザの許可を求めます。拒否した場合でも、タブに戻ったときにアプリ内トーストとタイトルバッジが表示されます。
+
+## 自動起動
+
+### Windows（タスク スケジューラ）
+
+1. `where sshler` を実行してインストールされた実行可能ファイルを見つけます（例: `%LOCALAPPDATA%\Programs\Python\Python312\Scripts\sshler.exe`）。
+2. **タスク スケジューラ → タスクの作成…** を開きます。
+3. **トリガー** で「ログオン時」を追加。
+4. **操作** で「プログラムの開始」を選択し、`sshler.exe` のパスを指定。引数に `serve --no-browser` を追加し、**開始** を書き込み可能なディレクトリに設定。
+5. WSL アクセスが必要な場合は「最上位の特権で実行する」にチェックを入れて保存。サインインするたびに sshler が自動起動します。
+
+### Linux / macOS（systemd ユーザーサービス）
+
+`~/.config/systemd/user/sshler.service` を作成:
+
+```ini
+[Unit]
+Description=sshler – local tmux bridge
+After=network.target
+
+[Service]
+Type=simple
+ExecStart=%h/.local/bin/sshler serve --bind 127.0.0.1 --no-browser
+Restart=on-failure
+
+[Install]
+WantedBy=default.target
+```
+
+リロードして有効化:
+
+```bash
+systemctl --user daemon-reload
+systemctl --user enable --now sshler.service
+```
+
+## 依存関係とライセンス
+
+- FastAPI、uvicorn、asyncssh、platformdirs、yaml（PyPI パッケージ、寛容なライセンス）
+- HTMX（MIT）と xterm.js（MIT）は unpkg から読み込まれます
+- CodeMirror（MIT）がエディタを駆動
+
+すべてのアセットはそれぞれの MIT/BSD スタイルのライセンスの下で使用されています。sshler 自体は MIT ライセンスで配布されます。
+
 ## 名前の由来
 
 VS Code だけに頼らず、ブラウザタブの中で軽快にターミナルを扱いたい──そんな願いからこの名前になりました。

{sshler-0.3.3 → sshler-0.4.0}/README.md

@@ -50,12 +50,10 @@ sshler serve
 
 The app will open `http://127.0.0.1:8822` in your default browser.
 
-## Configuration / 設定
+## Configuration
 
 sshler reads your existing OpenSSH config (`~/.ssh/config`) and shows every concrete `Host` entry automatically. Any favourites, default directories, or custom hosts you add through the UI are stored in a companion YAML file.
 
-- **日本語:** OpenSSH の設定 (`~/.ssh/config`) を読み取り、すべての `Host` が自動的に一覧に表示されます。お気に入りやデフォルトディレクトリ、カスタムホストは付属の YAML に保存されます。
-
 A config file is created on first run:
 
 - Windows: `%APPDATA%\sshler\boxes.yaml`
@@ -78,27 +76,21 @@ boxes:
     default_dir: /home/gabu
 ```
 
-> Tip: Set `default_dir` if your home path isn’t `/home/<user>`.
+> Tip: Set `default_dir` if your home path isn't `/home/<user>`.
 > If you rely on an OpenSSH alias, add `ssh_alias:` and sshler will run `ssh -G` to expand it when DNS fails.
 
-- **日本語のヒント:** ホームディレクトリが `/home/<user>` 以外なら `default_dir` を設定してください。OpenSSH のエイリアスを利用する場合は `ssh_alias:` を追加すると、DNS 失敗時に `ssh -G` で解決します。
-
-### Resetting overrides / 上書き設定のリセット
-
-Boxes imported from SSH config show a highlighted border and “Refresh” button. If you change something in `~/.ssh/config`, hit Refresh to drop any stored overrides (host/user/port/key) so the new settings take effect without editing `boxes.yaml`.
-
-- **日本語:** SSH 設定から取り込まれたボックスは枠が強調表示され、「Refresh」ボタンで上書き設定を削除できます。`~/.ssh/config` を更新した際はボタンを押すだけで最新状態になります。
+### Resetting overrides
 
-### Adding custom boxes / カスタムボックスの追加
+Boxes imported from SSH config show a highlighted border and "Refresh" button. If you change something in `~/.ssh/config`, hit Refresh to drop any stored overrides (host/user/port/key) so the new settings take effect without editing `boxes.yaml`.
 
-Hit “Add Box” in the UI to define a host that isn’t in your SSH config (for example, a throwaway Docker container). Fields you leave blank fall back to your SSH defaults.
+### Adding custom boxes
 
-- **日本語:** UI の “Add Box” から SSH 設定に存在しないホストも追加できます（例: 一時的な Docker コンテナ）。未入力の項目は SSH のデフォルト値が使われます。
+Hit "Add Box" in the UI to define a host that isn't in your SSH config (for example, a throwaway Docker container). Fields you leave blank fall back to your SSH defaults.
 
 ### Security model (important)
 
 - sshler is designed for **single-user localhost** use. By default `sshler serve` binds to `127.0.0.1` and prints a random `X-SSHLER-TOKEN` that every state-changing request must send.
-- File uploads are capped at 50 MB (tunable via `--max-upload-mb`). Uploaded content is never executed server-side.
+- File uploads are capped at 50 MB (tunable via `--max-upload-mb`). Uploaded content is never executed server-side.
 - SSH connections still honour your system `known_hosts`. Only set `known_hosts: ignore` if you fully understand the risk.
 - If you expose sshler beyond localhost, opt-in via `--allow-origin` and add `--auth user:pass` (basic auth). Use it only on networks you trust and put TLS in front (nginx, Caddy, etc.).
 - There is no telemetry, analytics, or call-home behaviour.
@@ -127,8 +119,6 @@ sshler serve \
 
 The server prints the token (and, if enabled, the basic auth username) on startup so you can copy it into API clients or browser extensions.
 
-- **日本語:** サーバー起動時にトークン（および Basic 認証を有効にした場合はユーザー名）を表示するので、API クライアントやブラウザ拡張に貼り付けて利用できます。
-
 ### Terminal notifications
 
 - Send a bell (`printf '\a'`) from tmux or your shell to flash the browser title and raise a desktop notification whenever the sshler tab is hidden.
@@ -136,19 +126,15 @@ The server prints the token (and, if enabled, the basic auth username) on startu
 - JSON payloads are also supported: `printf '\033]777;notify={"title":"Codex","message":"All tasks finished"}\a'`.
 - The first notification prompts the browser for permission. Denying it still leaves the in-app toast and title badge when you return to the tab.
 
-- **日本語:** タブが非表示のときに `printf '\a'` でベルを送ると、ブラウザタイトルが点滅しデスクトップ通知が表示されます。`printf '\033]777;notify=タイトル|本文\a'` で任意メッセージを送信でき、JSON (`notify={"title":"...","message":"..."}`) にも対応しています。初回は通知許可のダイアログが表示されますが、拒否した場合でもタブ復帰時にトーストとタイトルのバッジで気付けます。
-
-## Autostart / 自動起動
+## Autostart
 
 ### Windows (Task Scheduler)
 
 1. Run `where sshler` to locate the installed executable (for example, `%LOCALAPPDATA%\Programs\Python\Python312\Scripts\sshler.exe`).
 2. Open **Task Scheduler → Create Task…**.
-3. Under **Triggers**, add “At log on”.
-4. Under **Actions**, choose “Start a program” and point to the `sshler.exe` path. Add arguments such as `serve --no-browser` and set **Start in** to a writable directory.
-5. Tick “Run with highest privileges” if you need WSL access, then save. sshler will now launch automatically every time you sign in.
-
-- **日本語:** Task Scheduler で「ログオン時」をトリガーにし、`sshler.exe serve --no-browser` を実行するタスクを作成すると、サインイン時に自動起動します。
+3. Under **Triggers**, add "At log on".
+4. Under **Actions**, choose "Start a program" and point to the `sshler.exe` path. Add arguments such as `serve --no-browser` and set **Start in** to a writable directory.
+5. Tick "Run with highest privileges" if you need WSL access, then save. sshler will now launch automatically every time you sign in.
 
 ### Linux / macOS (systemd user service)
 
@@ -175,9 +161,7 @@ systemctl --user daemon-reload
 systemctl --user enable --now sshler.service
 ```
 
-- **日本語:** 上記の systemd ユーザーサービスを作成し、`systemctl --user enable --now sshler.service` を実行するとサインイン時に自動起動します。
-
-### Dependencies & licenses
+## Dependencies & licenses
 
 - FastAPI, uvicorn, asyncssh, platformdirs, yaml (PyPI packages, permissive licenses)
 - HTMX (MIT) and xterm.js (MIT) are loaded from unpkg
@@ -185,8 +169,6 @@ systemctl --user enable --now sshler.service
 
 All assets are used under their respective MIT/BSD-style licenses. sshler itself ships under the MIT license.
 
-- **日本語:** 依存ライブラリはいずれも寛容なライセンス (MIT/BSD) で提供されています。sshler 本体も MIT ライセンスで配布されます。
-
 ## Why "sshler"?
 
 Because sometimes you want less VS Code, more terminal — but still in a nice browser tab.
@@ -273,6 +255,96 @@ boxes:
 
 > ヒント: ホームパスが `/home/<user>` でない場合は `default_dir` を設定してください。OpenSSH エイリアスを使用する場合は `ssh_alias:` を追加すると、DNS 失敗時に `ssh -G` で解決します。
 
+### 上書き設定のリセット
+
+SSH 設定から取り込まれたボックスは枠が強調表示され、「Refresh」ボタンで上書き設定を削除できます。`~/.ssh/config` を更新した際はボタンを押すだけで最新状態になります。
+
+### カスタムボックスの追加
+
+UI の "Add Box" から SSH 設定に存在しないホストも追加できます（例: 一時的な Docker コンテナ）。未入力の項目は SSH のデフォルト値が使われます。
+
+### セキュリティモデル（重要）
+
+- sshler は **シングルユーザー・ローカルホスト専用** に設計されています。デフォルトでは `sshler serve` は `127.0.0.1` にバインドし、すべての状態変更リクエストに必要なランダムな `X-SSHLER-TOKEN` を出力します。
+- ファイルアップロードは 50 MB まで（`--max-upload-mb` で調整可能）。アップロードされたコンテンツはサーバー側で実行されません。
+- SSH 接続はシステムの `known_hosts` を尊重します。リスクを完全に理解している場合のみ `known_hosts: ignore` を設定してください。
+- ローカルホスト以外に公開する場合は、`--allow-origin` でオプトインし、`--auth user:pass`（Basic 認証）を追加してください。信頼できるネットワークでのみ使用し、TLS（nginx、Caddy など）を前段に配置してください。
+- テレメトリ、アナリティクス、コールホーム機能は一切ありません。
+
+### CLI オプション
+
+```bash
+sshler serve \
+  --host 127.0.0.1 \
+  --port 8822 \
+  --max-upload-mb 50 \
+  --allow-origin http://workstation:8822 \
+  --auth coder:supersecret \
+  --no-ssh-alias \
+  --log-level info
+```
+
+- `--host`（別名 `--bind`）: バインドアドレスを設定（デフォルト: `127.0.0.1` でローカルホストのみ）。すべてのインターフェースに公開するには `0.0.0.0` を使用しますが、**信頼できるネットワーク上でのみ `--auth` と TLS を併用してください**。
+- `--port`: ポート番号を設定（デフォルト: `8822`）。
+- `--allow-origin`: CORS を拡張するために繰り返し使用可能。ローカルホスト以外に UI を公開する場合は `--auth` と組み合わせてください。
+- `--auth user:pass`: HTTP Basic 認証を有効化（`0.0.0.0` にバインドする場合は推奨）。
+- `--max-upload-mb`: アップロードサイズ制限を設定（デフォルト: 50 MB）。
+- `--no-ssh-alias`: DNS 失敗時の `ssh -G` フォールバックを無効化。
+- `--token`: 独自の `X-SSHLER-TOKEN` を指定（指定しない場合は安全なランダム値が生成されます）。
+- `--log-level`: uvicorn に直接渡されます（オプション: `critical`、`error`、`warning`、`info`、`debug`、`trace`）。
+
+サーバーは起動時にトークン（および有効にした場合は Basic 認証のユーザー名）を出力するので、API クライアントやブラウザ拡張機能にコピーできます。
+
+### ターミナル通知
+
+- tmux またはシェルからベル（`printf '\a'`）を送信すると、sshler タブが非表示のときにブラウザタイトルが点滅し、デスクトップ通知が表示されます。
+- より豊富なメッセージには OSC 777 を使用: `printf '\033]777;notify=Codex%20done|Check%20the%20output\a'`。`|` の前のテキストがタイトルになり、後半が本文になります。
+- JSON ペイロードもサポート: `printf '\033]777;notify={"title":"Codex","message":"All tasks finished"}\a'`。
+- 初回の通知はブラウザの許可を求めます。拒否した場合でも、タブに戻ったときにアプリ内トーストとタイトルバッジが表示されます。
+
+## 自動起動
+
+### Windows（タスク スケジューラ）
+
+1. `where sshler` を実行してインストールされた実行可能ファイルを見つけます（例: `%LOCALAPPDATA%\Programs\Python\Python312\Scripts\sshler.exe`）。
+2. **タスク スケジューラ → タスクの作成…** を開きます。
+3. **トリガー** で「ログオン時」を追加。
+4. **操作** で「プログラムの開始」を選択し、`sshler.exe` のパスを指定。引数に `serve --no-browser` を追加し、**開始** を書き込み可能なディレクトリに設定。
+5. WSL アクセスが必要な場合は「最上位の特権で実行する」にチェックを入れて保存。サインインするたびに sshler が自動起動します。
+
+### Linux / macOS（systemd ユーザーサービス）
+
+`~/.config/systemd/user/sshler.service` を作成:
+
+```ini
+[Unit]
+Description=sshler – local tmux bridge
+After=network.target
+
+[Service]
+Type=simple
+ExecStart=%h/.local/bin/sshler serve --bind 127.0.0.1 --no-browser
+Restart=on-failure
+
+[Install]
+WantedBy=default.target
+```
+
+リロードして有効化:
+
+```bash
+systemctl --user daemon-reload
+systemctl --user enable --now sshler.service
+```
+
+## 依存関係とライセンス
+
+- FastAPI、uvicorn、asyncssh、platformdirs、yaml（PyPI パッケージ、寛容なライセンス）
+- HTMX（MIT）と xterm.js（MIT）は unpkg から読み込まれます
+- CodeMirror（MIT）がエディタを駆動
+
+すべてのアセットはそれぞれの MIT/BSD スタイルのライセンスの下で使用されています。sshler 自体は MIT ライセンスで配布されます。
+
 ## 名前の由来
 
 VS Code だけに頼らず、ブラウザタブの中で軽快にターミナルを扱いたい──そんな願いからこの名前になりました。

{sshler-0.3.3 → sshler-0.4.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sshler"
-version = "0.3.3"
+version = "0.4.0"
 description = "A local FastAPI-powered SSH multiplexer for tmux-in-browser — from your laptop only."
 readme = "README.md"
 requires-python = ">=3.12"

{sshler-0.3.3 → sshler-0.4.0}/sshler/webapp.py

@@ -12,7 +12,6 @@ from dataclasses import dataclass, field
 from pathlib import Path, PurePosixPath
 
 import asyncssh
-from markdown_it import MarkdownIt
 from fastapi import (
     Depends,
     FastAPI,
@@ -29,6 +28,7 @@ from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import HTMLResponse, PlainTextResponse, RedirectResponse, Response
 from fastapi.staticfiles import StaticFiles
 from fastapi.templating import Jinja2Templates
+from markdown_it import MarkdownIt
 
 from . import __version__, state
 from .config import (
@@ -265,7 +265,8 @@ async def _open_local_tmux(
     # For now, let's try using script to provide a PTY
     if LOCAL_IS_WINDOWS:
         # Use 'script' command in WSL to create a PTY
-        script_command = ["wsl", "--", "script", "-qfc", " ".join(f"'{arg}'" if " " in arg else arg for arg in command[2:]), "/dev/null"]
+        cmd_str = " ".join(f"'{arg}'" if " " in arg else arg for arg in command[2:])
+        script_command = ["wsl", "--", "script", "-qfc", cmd_str, "/dev/null"]
         return await asyncio.create_subprocess_exec(
             *script_command,
             stdin=asyncio.subprocess.PIPE,
@@ -1650,7 +1651,10 @@ def make_app(settings: ServerSettings | None = None) -> FastAPI:
                     normalized_directory = _normalize_local_path(box.default_dir)
 
                 # Debug: Log the command we're about to run
-                logger.info(f"Starting local tmux: transport={transport}, dir={normalized_directory}, session={session}")
+                logger.info(
+                    f"Starting local tmux: transport={transport}, "
+                    f"dir={normalized_directory}, session={session}"
+                )
 
                 try:
                     process = await _open_local_tmux(normalized_directory, session)
@@ -1730,7 +1734,8 @@ def make_app(settings: ServerSettings | None = None) -> FastAPI:
                                 transport,
                             )
                         elif "bytes" in message and message["bytes"] is not None:
-                            logger.debug(f"Writer: got {len(message['bytes'])} bytes, writing to stdin")
+                            num_bytes = len(message["bytes"])
+                            logger.debug(f"Writer: got {num_bytes} bytes, writing to stdin")
                             process.stdin.write(message["bytes"])
                 except WebSocketDisconnect:
                     logger.info("Writer: websocket disconnected")

{sshler-0.3.3 → sshler-0.4.0/sshler.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sshler
-Version: 0.3.3
+Version: 0.4.0
 Summary: A local FastAPI-powered SSH multiplexer for tmux-in-browser — from your laptop only.
 Author: You
 License-Expression: MIT
@@ -91,12 +91,10 @@ sshler serve
 
 The app will open `http://127.0.0.1:8822` in your default browser.
 
-## Configuration / 設定
+## Configuration
 
 sshler reads your existing OpenSSH config (`~/.ssh/config`) and shows every concrete `Host` entry automatically. Any favourites, default directories, or custom hosts you add through the UI are stored in a companion YAML file.
 
-- **日本語:** OpenSSH の設定 (`~/.ssh/config`) を読み取り、すべての `Host` が自動的に一覧に表示されます。お気に入りやデフォルトディレクトリ、カスタムホストは付属の YAML に保存されます。
-
 A config file is created on first run:
 
 - Windows: `%APPDATA%\sshler\boxes.yaml`
@@ -119,27 +117,21 @@ boxes:
     default_dir: /home/gabu
 ```
 
-> Tip: Set `default_dir` if your home path isn’t `/home/<user>`.
+> Tip: Set `default_dir` if your home path isn't `/home/<user>`.
 > If you rely on an OpenSSH alias, add `ssh_alias:` and sshler will run `ssh -G` to expand it when DNS fails.
 
-- **日本語のヒント:** ホームディレクトリが `/home/<user>` 以外なら `default_dir` を設定してください。OpenSSH のエイリアスを利用する場合は `ssh_alias:` を追加すると、DNS 失敗時に `ssh -G` で解決します。
-
-### Resetting overrides / 上書き設定のリセット
-
-Boxes imported from SSH config show a highlighted border and “Refresh” button. If you change something in `~/.ssh/config`, hit Refresh to drop any stored overrides (host/user/port/key) so the new settings take effect without editing `boxes.yaml`.
-
-- **日本語:** SSH 設定から取り込まれたボックスは枠が強調表示され、「Refresh」ボタンで上書き設定を削除できます。`~/.ssh/config` を更新した際はボタンを押すだけで最新状態になります。
+### Resetting overrides
 
-### Adding custom boxes / カスタムボックスの追加
+Boxes imported from SSH config show a highlighted border and "Refresh" button. If you change something in `~/.ssh/config`, hit Refresh to drop any stored overrides (host/user/port/key) so the new settings take effect without editing `boxes.yaml`.
 
-Hit “Add Box” in the UI to define a host that isn’t in your SSH config (for example, a throwaway Docker container). Fields you leave blank fall back to your SSH defaults.
+### Adding custom boxes
 
-- **日本語:** UI の “Add Box” から SSH 設定に存在しないホストも追加できます（例: 一時的な Docker コンテナ）。未入力の項目は SSH のデフォルト値が使われます。
+Hit "Add Box" in the UI to define a host that isn't in your SSH config (for example, a throwaway Docker container). Fields you leave blank fall back to your SSH defaults.
 
 ### Security model (important)
 
 - sshler is designed for **single-user localhost** use. By default `sshler serve` binds to `127.0.0.1` and prints a random `X-SSHLER-TOKEN` that every state-changing request must send.
-- File uploads are capped at 50 MB (tunable via `--max-upload-mb`). Uploaded content is never executed server-side.
+- File uploads are capped at 50 MB (tunable via `--max-upload-mb`). Uploaded content is never executed server-side.
 - SSH connections still honour your system `known_hosts`. Only set `known_hosts: ignore` if you fully understand the risk.
 - If you expose sshler beyond localhost, opt-in via `--allow-origin` and add `--auth user:pass` (basic auth). Use it only on networks you trust and put TLS in front (nginx, Caddy, etc.).
 - There is no telemetry, analytics, or call-home behaviour.
@@ -168,8 +160,6 @@ sshler serve \
 
 The server prints the token (and, if enabled, the basic auth username) on startup so you can copy it into API clients or browser extensions.
 
-- **日本語:** サーバー起動時にトークン（および Basic 認証を有効にした場合はユーザー名）を表示するので、API クライアントやブラウザ拡張に貼り付けて利用できます。
-
 ### Terminal notifications
 
 - Send a bell (`printf '\a'`) from tmux or your shell to flash the browser title and raise a desktop notification whenever the sshler tab is hidden.
@@ -177,19 +167,15 @@ The server prints the token (and, if enabled, the basic auth username) on startu
 - JSON payloads are also supported: `printf '\033]777;notify={"title":"Codex","message":"All tasks finished"}\a'`.
 - The first notification prompts the browser for permission. Denying it still leaves the in-app toast and title badge when you return to the tab.
 
-- **日本語:** タブが非表示のときに `printf '\a'` でベルを送ると、ブラウザタイトルが点滅しデスクトップ通知が表示されます。`printf '\033]777;notify=タイトル|本文\a'` で任意メッセージを送信でき、JSON (`notify={"title":"...","message":"..."}`) にも対応しています。初回は通知許可のダイアログが表示されますが、拒否した場合でもタブ復帰時にトーストとタイトルのバッジで気付けます。
-
-## Autostart / 自動起動
+## Autostart
 
 ### Windows (Task Scheduler)
 
 1. Run `where sshler` to locate the installed executable (for example, `%LOCALAPPDATA%\Programs\Python\Python312\Scripts\sshler.exe`).
 2. Open **Task Scheduler → Create Task…**.
-3. Under **Triggers**, add “At log on”.
-4. Under **Actions**, choose “Start a program” and point to the `sshler.exe` path. Add arguments such as `serve --no-browser` and set **Start in** to a writable directory.
-5. Tick “Run with highest privileges” if you need WSL access, then save. sshler will now launch automatically every time you sign in.
-
-- **日本語:** Task Scheduler で「ログオン時」をトリガーにし、`sshler.exe serve --no-browser` を実行するタスクを作成すると、サインイン時に自動起動します。
+3. Under **Triggers**, add "At log on".
+4. Under **Actions**, choose "Start a program" and point to the `sshler.exe` path. Add arguments such as `serve --no-browser` and set **Start in** to a writable directory.
+5. Tick "Run with highest privileges" if you need WSL access, then save. sshler will now launch automatically every time you sign in.
 
 ### Linux / macOS (systemd user service)
 
@@ -216,9 +202,7 @@ systemctl --user daemon-reload
 systemctl --user enable --now sshler.service
 ```
 
-- **日本語:** 上記の systemd ユーザーサービスを作成し、`systemctl --user enable --now sshler.service` を実行するとサインイン時に自動起動します。
-
-### Dependencies & licenses
+## Dependencies & licenses
 
 - FastAPI, uvicorn, asyncssh, platformdirs, yaml (PyPI packages, permissive licenses)
 - HTMX (MIT) and xterm.js (MIT) are loaded from unpkg
@@ -226,8 +210,6 @@ systemctl --user enable --now sshler.service
 
 All assets are used under their respective MIT/BSD-style licenses. sshler itself ships under the MIT license.
 
-- **日本語:** 依存ライブラリはいずれも寛容なライセンス (MIT/BSD) で提供されています。sshler 本体も MIT ライセンスで配布されます。
-
 ## Why "sshler"?
 
 Because sometimes you want less VS Code, more terminal — but still in a nice browser tab.
@@ -314,6 +296,96 @@ boxes:
 
 > ヒント: ホームパスが `/home/<user>` でない場合は `default_dir` を設定してください。OpenSSH エイリアスを使用する場合は `ssh_alias:` を追加すると、DNS 失敗時に `ssh -G` で解決します。
 
+### 上書き設定のリセット
+
+SSH 設定から取り込まれたボックスは枠が強調表示され、「Refresh」ボタンで上書き設定を削除できます。`~/.ssh/config` を更新した際はボタンを押すだけで最新状態になります。
+
+### カスタムボックスの追加
+
+UI の "Add Box" から SSH 設定に存在しないホストも追加できます（例: 一時的な Docker コンテナ）。未入力の項目は SSH のデフォルト値が使われます。
+
+### セキュリティモデル（重要）
+
+- sshler は **シングルユーザー・ローカルホスト専用** に設計されています。デフォルトでは `sshler serve` は `127.0.0.1` にバインドし、すべての状態変更リクエストに必要なランダムな `X-SSHLER-TOKEN` を出力します。
+- ファイルアップロードは 50 MB まで（`--max-upload-mb` で調整可能）。アップロードされたコンテンツはサーバー側で実行されません。
+- SSH 接続はシステムの `known_hosts` を尊重します。リスクを完全に理解している場合のみ `known_hosts: ignore` を設定してください。
+- ローカルホスト以外に公開する場合は、`--allow-origin` でオプトインし、`--auth user:pass`（Basic 認証）を追加してください。信頼できるネットワークでのみ使用し、TLS（nginx、Caddy など）を前段に配置してください。
+- テレメトリ、アナリティクス、コールホーム機能は一切ありません。
+
+### CLI オプション
+
+```bash
+sshler serve \
+  --host 127.0.0.1 \
+  --port 8822 \
+  --max-upload-mb 50 \
+  --allow-origin http://workstation:8822 \
+  --auth coder:supersecret \
+  --no-ssh-alias \
+  --log-level info
+```
+
+- `--host`（別名 `--bind`）: バインドアドレスを設定（デフォルト: `127.0.0.1` でローカルホストのみ）。すべてのインターフェースに公開するには `0.0.0.0` を使用しますが、**信頼できるネットワーク上でのみ `--auth` と TLS を併用してください**。
+- `--port`: ポート番号を設定（デフォルト: `8822`）。
+- `--allow-origin`: CORS を拡張するために繰り返し使用可能。ローカルホスト以外に UI を公開する場合は `--auth` と組み合わせてください。
+- `--auth user:pass`: HTTP Basic 認証を有効化（`0.0.0.0` にバインドする場合は推奨）。
+- `--max-upload-mb`: アップロードサイズ制限を設定（デフォルト: 50 MB）。
+- `--no-ssh-alias`: DNS 失敗時の `ssh -G` フォールバックを無効化。
+- `--token`: 独自の `X-SSHLER-TOKEN` を指定（指定しない場合は安全なランダム値が生成されます）。
+- `--log-level`: uvicorn に直接渡されます（オプション: `critical`、`error`、`warning`、`info`、`debug`、`trace`）。
+
+サーバーは起動時にトークン（および有効にした場合は Basic 認証のユーザー名）を出力するので、API クライアントやブラウザ拡張機能にコピーできます。
+
+### ターミナル通知
+
+- tmux またはシェルからベル（`printf '\a'`）を送信すると、sshler タブが非表示のときにブラウザタイトルが点滅し、デスクトップ通知が表示されます。
+- より豊富なメッセージには OSC 777 を使用: `printf '\033]777;notify=Codex%20done|Check%20the%20output\a'`。`|` の前のテキストがタイトルになり、後半が本文になります。
+- JSON ペイロードもサポート: `printf '\033]777;notify={"title":"Codex","message":"All tasks finished"}\a'`。
+- 初回の通知はブラウザの許可を求めます。拒否した場合でも、タブに戻ったときにアプリ内トーストとタイトルバッジが表示されます。
+
+## 自動起動
+
+### Windows（タスク スケジューラ）
+
+1. `where sshler` を実行してインストールされた実行可能ファイルを見つけます（例: `%LOCALAPPDATA%\Programs\Python\Python312\Scripts\sshler.exe`）。
+2. **タスク スケジューラ → タスクの作成…** を開きます。
+3. **トリガー** で「ログオン時」を追加。
+4. **操作** で「プログラムの開始」を選択し、`sshler.exe` のパスを指定。引数に `serve --no-browser` を追加し、**開始** を書き込み可能なディレクトリに設定。
+5. WSL アクセスが必要な場合は「最上位の特権で実行する」にチェックを入れて保存。サインインするたびに sshler が自動起動します。
+
+### Linux / macOS（systemd ユーザーサービス）
+
+`~/.config/systemd/user/sshler.service` を作成:
+
+```ini
+[Unit]
+Description=sshler – local tmux bridge
+After=network.target
+
+[Service]
+Type=simple
+ExecStart=%h/.local/bin/sshler serve --bind 127.0.0.1 --no-browser
+Restart=on-failure
+
+[Install]
+WantedBy=default.target
+```
+
+リロードして有効化:
+
+```bash
+systemctl --user daemon-reload
+systemctl --user enable --now sshler.service
+```
+
+## 依存関係とライセンス
+
+- FastAPI、uvicorn、asyncssh、platformdirs、yaml（PyPI パッケージ、寛容なライセンス）
+- HTMX（MIT）と xterm.js（MIT）は unpkg から読み込まれます
+- CodeMirror（MIT）がエディタを駆動
+
+すべてのアセットはそれぞれの MIT/BSD スタイルのライセンスの下で使用されています。sshler 自体は MIT ライセンスで配布されます。
+
 ## 名前の由来
 
 VS Code だけに頼らず、ブラウザタブの中で軽快にターミナルを扱いたい──そんな願いからこの名前になりました。

{sshler-0.3.3 → sshler-0.4.0}/tests/test_routes.py

@@ -20,8 +20,25 @@ def build_client() -> TestClient:
     return TestClient(make_app(ServerSettings(csrf_token=TEST_TOKEN)))
 
 
-def test_directory_listing_returns_error_message(monkeypatch):
-    ensure_config()
+def test_directory_listing_returns_error_message(monkeypatch, tmp_path):
+    config_dir = tmp_path / "config"
+    config_dir.mkdir()
+    monkeypatch.setenv("SSHLER_CONFIG_DIR", str(config_dir))
+    (config_dir / "boxes.yaml").write_text(
+        yaml.safe_dump({"boxes": []}, sort_keys=False), encoding="utf-8"
+    )
+
+    ssh_config = tmp_path / "ssh_config"
+    ssh_config.write_text(
+        """
+Host gabu-server
+  HostName gabu.example.com
+  User gabu
+""".strip(),
+        encoding="utf-8",
+    )
+    monkeypatch.setenv("SSHLER_SSH_CONFIG", str(ssh_config))
+
     client = build_client()
     try:
 

{sshler-0.3.3 → sshler-0.4.0}/tests/test_websocket.py

@@ -63,37 +63,61 @@ def configured_app_fixture() -> TestClient:
         client.close()
 
 
-def test_websocket_falls_back_to_default_directory(monkeypatch, configured_app: TestClient):
-    config = load_config()
-    box = next(b for b in config.boxes if b.name != "local")
-    fallback_directory = box.default_dir or f"/home/{box.user}"
+def test_websocket_falls_back_to_default_directory(monkeypatch, tmp_path):
+    import yaml
+
+    config_dir = tmp_path / "config"
+    config_dir.mkdir()
+    monkeypatch.setenv("SSHLER_CONFIG_DIR", str(config_dir))
+    (config_dir / "boxes.yaml").write_text(
+        yaml.safe_dump({"boxes": []}, sort_keys=False), encoding="utf-8"
+    )
+
+    ssh_config = tmp_path / "ssh_config"
+    ssh_config.write_text(
+        """
+Host demo-box
+  HostName demo.internal
+  User demo
+""".strip(),
+        encoding="utf-8",
+    )
+    monkeypatch.setenv("SSHLER_SSH_CONFIG", str(ssh_config))
 
-    fake_process = FakeProcess()
-    captured: dict[str, object] = {}
+    client = TestClient(make_app(ServerSettings(csrf_token=TEST_TOKEN)))
+    try:
+        config = load_config()
+        box = next(b for b in config.boxes if b.name != "local")
+        fallback_directory = box.default_dir or f"/home/{box.user}"
 
-    async def fake_connect(*_args, **_kwargs):
-        return FakeConnection()
+        fake_process = FakeProcess()
+        captured: dict[str, object] = {}
 
-    async def fake_sftp_is_directory(_connection, _path):
-        return False
+        async def fake_connect(*_args, **_kwargs):
+            return FakeConnection()
 
-    async def fake_open_tmux(*_args, **kwargs):
-        captured["working_directory"] = kwargs["working_directory"]
-        return fake_process
+        async def fake_sftp_is_directory(_connection, _path):
+            return False
 
-    monkeypatch.setattr("sshler.webapp.connect", fake_connect)
-    monkeypatch.setattr("sshler.webapp.sftp_is_directory", fake_sftp_is_directory)
-    monkeypatch.setattr("sshler.webapp.open_tmux", fake_open_tmux)
+        async def fake_open_tmux(*_args, **kwargs):
+            captured["working_directory"] = kwargs["working_directory"]
+            return fake_process
 
-    with configured_app.websocket_connect(
-        f"/ws/term?host={box.name}&dir=/does-not-exist&session=check&token={TEST_TOKEN}"
-    ) as websocket:
-        websocket.send_bytes(b"hello")
+        monkeypatch.setattr("sshler.webapp.connect", fake_connect)
+        monkeypatch.setattr("sshler.webapp.sftp_is_directory", fake_sftp_is_directory)
+        monkeypatch.setattr("sshler.webapp.open_tmux", fake_open_tmux)
+
+        with client.websocket_connect(
+            f"/ws/term?host={box.name}&dir=/does-not-exist&session=check&token={TEST_TOKEN}"
+        ) as websocket:
+            websocket.send_bytes(b"hello")
 
-    assert captured["working_directory"] == fallback_directory
-    assert fake_process.stdin.messages == [b"hello"]
-    assert fake_process.stdin.eof_called is True
-    assert fake_process.closed is True
+        assert captured["working_directory"] == fallback_directory
+        assert fake_process.stdin.messages == [b"hello"]
+        assert fake_process.stdin.eof_called is True
+        assert fake_process.closed is True
+    finally:
+        client.close()
 
 
 def test_local_box_connects_successfully(monkeypatch, configured_app: TestClient):