Skip to content

docs: add SSH record mode to README.ja.md #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cotta-dev merged 1 commit into from
Apr 2, 2026
Merged

docs: add SSH record mode to README.ja.md #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 13 additions & 2 deletions README.ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ Windows での作業でおなじみの **TeraTerm のログ機能＋マクロの

## 主な機能

* **作業ログの自動記録**: オプションなしで実行すると、現在のシェルセッションをそのままログファイルに記録できます（TeraTerm のログ機能相当）。
* **ローカル作業ログの自動記録**: 引数なしで実行すると、現在のシェルセッションをそのままログファイルに記録できます（TeraTerm のログ機能相当）。
* **SSH + 作業ログ記録**: ホスト名を引数に指定すると、SSH 接続してセッション全体を自動記録します。
* **コマンド自動実行 & ログ収集**: 設定ファイルに定義したコマンドを複数ホストへ一括実行し、タイムスタンプ付きログとして保存（TeraTerm マクロ相当）。
* **エージェントレス**: 標準の SSH のみ使用。リモートホストへのソフトウェアインストール不要。
* **依存関係なし**: 単一バイナリ（静的リンク）。インストールして即使える。
Expand Down Expand Up @@ -55,7 +56,7 @@ CGO_ENABLED=0 go install github.com/cotta-dev/retri@latest

## 使い方

### 作業ログを取る（オプションなし）
### 作業ログを取る（引数なし）

引数なしで実行すると、現在のシェルセッションの記録を開始します。TeraTerm のログ機能と同様に、打ったコマンドと出力をそのままファイルに残せます。

Expand All @@ -65,6 +66,16 @@ retri
# → exit または Ctrl-D で終了
```

### SSH + 作業ログ（ホスト名を引数に指定）

ホスト名を引数に指定すると、そのホストに SSH 接続し、セッション全体を自動記録します。

```bash
retri myserver
# → myserver に SSH 接続し ~/retri-logs/myserver_YYYYMMDD_HHmmss.log に記録開始
# → exit で切断 & 記録終了
```

### コマンドを自動実行してログを収集する

単一ホストでコマンドを実行（`~/.ssh/config` のエイリアスを使用）：
Expand Down
Loading