Skip to content

README.ja.md

Latest commit

 

History

History
151 lines (108 loc) · 6.09 KB

README.ja.md

File metadata and controls

151 lines (108 loc) · 6.09 KB

Retri

English | 日本語

CI Release License: MIT

SSH ログ収集 & コマンド自動実行ツール

Retri という名前は、獲物を持ち帰ることが得意な犬種「レトリーバー」に由来しています。複数のサーバーからログを "取ってくる" 動作そのものを表しています。

Windows での作業でおなじみの TeraTerm のログ機能＋マクロの組み合わせ を、WSL（Windows Subsystem for Linux）でも使いたいという動機から生まれました。設定ファイルにコマンドを書いておけば、SSH 接続・コマンド実行・ログ保存を一括で自動化できます。

主な機能

  • ローカル作業ログの自動記録: 引数なしで実行すると、現在のシェルセッションをそのままログファイルに記録できます（TeraTerm のログ機能相当）。
  • SSH + 作業ログ記録: ホスト名を引数に指定すると、SSH 接続してセッション全体を自動記録します。
  • コマンド自動実行 & ログ収集: 設定ファイルに定義したコマンドを複数ホストへ一括実行し、タイムスタンプ付きログとして保存（TeraTerm マクロ相当）。
  • エージェントレス: 標準の SSH のみ使用。リモートホストへのソフトウェアインストール不要。
  • 依存関係なし: 単一バイナリ（静的リンク）。インストールして即使える。
  • ネットワーク機器対応: Cisco IOS・Arista EOS・Juniper・Huawei など、PTY 対話が必要な機器も自動処理。パスワードはログに残りません。
  • 並列実行: 複数台のサーバーに対して同時実行。台数が増えても待ち時間を最小化。
  • SSH Config 対応: ~/.ssh/config（エイリアス、ProxyJump、鍵ファイル等）をそのまま利用可能。

インストール

Ubuntu/Debian（推奨）

curl -fsSL $(curl -fsSL https://api.github.com/repos/cotta-dev/retri/releases/latest \
  | grep browser_download_url | grep "$(dpkg --print-architecture).deb" | cut -d'"' -f4) \
  -o /tmp/retri.deb && sudo apt-get install -y /tmp/retri.deb

または Releases ページ から .deb を手動でダウンロード：

cp retri_VERSION_amd64.deb /tmp/
sudo apt-get install -y /tmp/retri_VERSION_amd64.deb

ソースからビルド

git clone https://github.com/cotta-dev/retri.git
cd retri
CGO_ENABLED=0 go build -o retri -ldflags="-s -w" .

Go でインストール

CGO_ENABLED=0 go install github.com/cotta-dev/retri@latest

使い方

作業ログを取る（引数なし）

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

retri
# → ~/retri-logs/hostname_YYYYMMDD_HHmmss.log に記録開始
# → exit または Ctrl-D で終了

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

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

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

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

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

retri --host myserver --command "df -h"

設定ファイルで定義したグループのサーバーでコマンドを実行：

retri --group web_servers

コマンドラインオプション

docs/cli-options.md を参照してください。

設定

初回実行時に、デフォルトの設定ファイルが ~/.config/retri/config.yaml に自動作成されます。

config.yaml の例

各セクションの全パラメーターは docs/config-reference.yaml を参照してください。

環境変数とセキュリティ

設定ファイルにパスワードをハードコードしないでください。${VAR} 展開を活用します：

export COMMON_SSH_PASSWORD="my_secret_password"
defaults:
  password: "${COMMON_SSH_PASSWORD}"

フォールバック環境変数（最低優先度）：

変数 説明
RETRI_SSH_PASSWORD 設定ファイルで未指定時の SSH パスワード。
RETRI_SSH_SECRET 設定ファイルで未指定時の Sudo シークレット。

出力フォーマット

ログはデフォルトで ~/retri-logs に保存されます。

ファイル: myserver_20260403_010842.log

============================================================
 TARGET HOST : myserver
 DEVICE TYPE : linux
 START TIME  : 2026-04-03 01:08:42
============================================================
[2026-04-03 01:08:43.550] 
[2026-04-03 01:08:43.551] ----------------------------------------
[2026-04-03 01:08:43.551] [EXEC] uptime
[2026-04-03 01:08:43.551] ----------------------------------------
[2026-04-03 01:08:43.594]  01:08:43 up 77 days,  9:44,  0 user,  load average: 0.10, 0.56, 0.40
[2026-04-03 01:08:43.595] 
[2026-04-03 01:08:43.595] ----------------------------------------
[2026-04-03 01:08:43.595] [EXEC] sudo whoami
[2026-04-03 01:08:43.595] ----------------------------------------
[2026-04-03 01:08:43.596] root

============================================================
 LOG END     : 2026-04-03 01:08:43
============================================================

ライセンス

MIT License で配布しています。詳細は LICENSE を参照してください。