lssh

ls + ssh = lssh

lsshは、SSHワークフロー、クラウドインベントリ、プロバイダー対応コネクタのためのターミナルネイティブのリモートアクセススイートです。

OpenSSH設定、lssh設定、またはプロバイダーのインベントリからホストを選択し、ネイティブSSHまたはAWS SSM、EC2 Instance Connect Endpoint、WinRM、Telnet、カスタムプロバイダーなどのコネクタバックエンドを通じて操作できます。

インタラクティブシェル、並列コマンド、マルチプレックスワークスペース、ファイル転送、同期、マウント、監視に使用できます。コネクタ対応ホストは、そのコネクタがサポートする操作のみを公開します。

• 既存のSSH設定で動作
• インタラクティブなホスト選択
• 並列コマンド実行

Install

Homebrew

brew install blacknon/lssh/lssh

Go

go install github.com/blacknon/lssh/cmd/lssh@latest

プロバイダー対応のインベントリおよびコネクタ機能は、個別のプロバイダー実行可能ファイルを使用します。cmd/lsshのみをインストールした場合、これらのプロバイダーバイナリは自動的にインストールされません。

ローカル開発では、以下のコマンドでバンドルされたプロバイダーをインストールしてください：

mise run provider_install

リリースビルドの場合は、オールインワンのlssh-complete_*アーカイブをインストールするか、GitHub Releasesから対応するlssh-providers_*アーカイブを追加してください。

その他のオプションやプラットフォーム固有の注意事項を含むインストールの詳細については、docs/install.mdを参照してください。

Quick start

すでに~/.ssh/configを使用していますか？

以下のコマンドを実行するだけです：

lssh

既存のSSH設定からlssh設定を生成しますか？

lssh --generate-lssh-conf > ~/.lssh.toml

Basic workflow

lsshはシンプルなワークフローを前提に設計されています：

1. SSH設定からホストを一覧表示
2. 1つ以上のホストを選択
3. シェルを開くかコマンドを実行

Examples

接続先がわかっている場合は、単一のホストを直接指定することもできます：

lssh -H my-server

設定形式と設定の詳細については、cmd/lssh/README.mdを参照してください。

Demo

lsshをすぐに実行可能なローカルプレイグラウンドで試したい場合は、demo/README.mdから始めてください。telnetコネクタ＋マルチホッププロバイダーフローについては、demo-telnet-provider/README.mdを使用してください。

OpenSSH config and lssh config

lsshは、既存のOpenSSH設定と独自の設定形式の両方をサポートしています。

すぐに使い始めたい場合は、~/.ssh/configをそのまま使い続けることができます。よりリッチなホストメタデータとワークフロー指向の設定が必要な場合は、代わりにlssh設定に移行できます。

既存のSSH設定からlssh設定を生成することもできます：

lssh --generate-lssh-conf > ~/.lssh.toml

lssh設定に移行した後も、既存のOpenSSH設定を指してそこからホストを読み込むことができます：

[sshconfig.default]
path = "~/.ssh/config"

設定形式と設定の詳細については、docs/configuration.mdを参照してください。

Providers

lsshは静的なSSH設定エントリだけではなく、プロバイダーを使用して外部インベントリソースからホストを取得したり、接続直前にシークレットを解決したり、クラウド管理コネクタなどの非SSH接続バックエンドを使用したりできます。

v0.10.0では、プロバイダー対応のインベントリおよびシークレットワークフローはベータ版として扱うことを推奨します。ネイティブSSHを超えるコネクタ対応アクセスは、特にクラウド管理ランタイムや非SSHバックエンドについては、まだ実験的です。

プロバイダー指向のフローをローカルで試すには、以下のデモから始めてください：

• demo/README.md：コアSSH、プロキシチェーン、一般的なマルチホストワークフローの例
• demo-telnet-provider/README.md：プロバイダー管理のtelnetコネクタフロー（直接telnetアクセスとダブルSSHホップ経由のtelnetを含む）

プロバイダーアーキテクチャとプロトコルの概要については、provider/README.mdから始めてください。カテゴリの詳細は、inventory、connector、secret、mixedにも文書化されています。

Bundled providers

これらのプロバイダー実装は現在このリポジトリにバンドルされています。

Inventory

Connector

Mixed

Secret

Tools in the lssh suite

lsshプロジェクトには、SSH中心のワークフローのための複数のツールが含まれています。

Docs

• docs/README.md: ドキュメントインデックス
• cmd/lssh/README.md: lsshコマンドの詳細、転送、ローカルrcの使用法
• cmd/README.md: コマンド概要
• CONTRIBUTING.md: 開発とコントリビューションのガイドライン

Related projects

• go-sshlib: SSH接続、コマンド実行、インタラクティブシェル用のGoライブラリ
• tvxterm: tview用のターミナルウィジェットを提供するtvxterm
• boco: Bash Shell Functionのファジーファインダー。

Alternatives

lsshを評価する場合、これらのプロジェクトも一見の価値があります。これらはスイートの一部と重複しますが、通常はワークフロー全体の狭い部分をカバーします。

How the lssh suite is different

• lsshは、ホスト選択、インタラクティブSSH、並列コマンド実行、転送、コネクタ/プロバイダー対応ターゲットを組み合わせています。
• lsshellは、多くのターミナルを起動する代わりに、並列インタラクティブシェルワークフローに焦点を当てています。
• lscp、lsftp、lssyncは、同じスイート内のファーストクラスコマンドとしてファイル転送と同期をカバーします。
• lsmuxは、セッションテンプレーティングだけでなく、ペイン型SSHワークスペースを提供します。
• lspipeは、選択したホストをローカルパイプラインや自動化から再利用可能に保ちます。

License

MIT

Author

blacknon