Skip to content

README_ja.md

Latest commit

 

History

History
113 lines (77 loc) · 4.65 KB

README_ja.md

File metadata and controls

113 lines (77 loc) · 4.65 KB
Raw

UnityHub CLI

English version

Unity Hubと同じ内容をInkベースのTUIで表示し、上下キー/j/kでプロジェクトを選択してoでUnity Editorを起動するCLIです。

スクリーンショット 2025-10-27 23 44 40

必要環境

  • macOS または Windows 10/11
  • Node.js 20+

インストール・実行

npx unity-hub-cli

または、グローバルインストールすると unity-hub-cli コマンドで直接起動できます：

npm install -g unity-hub-cli
unity-hub-cli
Windowsでの注意事項

PowerShell / CMD で動作します。Git Bash は ConPTY ベースのターミナル（Windows Terminal / VS Code・Cursor の統合ターミナル）内であれば動作します。

スタンドアロンの Git Bash（MinTTY）では Raw mode が非対応のため、PowerShell / CMD / Windows Terminal をお使いください。どうしても使う場合は以下のコマンドを利用できます：

  • winpty cmd.exe /c npx unity-hub-cli
  • winpty powershell.exe -NoProfile -Command npx unity-hub-cli

操作方法

キー 動作
↑ / ↓ / j / k 選択移動
o 選択中のプロジェクトをUnityで起動
O (Shift+O) Unity + 外部エディタ（Rider等）を同時起動
i 外部エディタのみ起動
q 選択中のプロジェクトのUnityを終了
r プロジェクト一覧を更新
c プロジェクトパスをクリップボードにコピー（unity-hub 関数経由ではそのディレクトリに cd して終了）
s ソート設定パネルを開く
v 表示設定パネルを開く
Ctrl + C 終了

設定パネル内では j/k で移動、Space で切り替え、Esc で閉じます。

表示内容にはGitブランチ（存在する場合）、Unityバージョン、プロジェクトパス、最終更新日時が含まれます。利用可能な場合、デフォルトでGitリポジトリのルートフォルダ名を使って一覧を表示します。

CLIオプション

  • --no-git-root-name: Gitリポジトリのルートフォルダ名ではなく、Unityプロジェクトのタイトルを表示します
  • --shell-init: 自動 cd 統合用のシェル関数をインストールします（確認プロンプト付き）。
  • --shell-init --dry-run: シェル関数をプレビュー表示します（インストールはしません）。
  • update: グローバルインストール済みの unity-hub-cli を最新バージョンに更新します（確認プロンプト後に npm install -g unity-hub-cli@latest --ignore-scripts --no-fund を実行）。

シェル統合

Unity起動後、自動的にそのプロジェクトディレクトリに cd するシェル関数を追加できます。

セットアップ

  1. グローバルインストール：
npm install -g unity-hub-cli
  1. シェル初期化コマンドを実行（シェルを自動検出）：
unity-hub-cli --shell-init

これでシェル設定ファイル（.zshrc、.bashrc、config.fish、PowerShellプロファイル）に unity-hub 関数が自動的に追加されます。

  1. シェルを再読み込み：
source ~/.zshrc  # またはターミナルを再起動

使い方

これで unity-hub 関数を使うと：

  1. Unityプロジェクト一覧を表示・選択
  2. o でUnityを起動
  3. ターミナルがプロジェクトのディレクトリに自動で cd される

備考

  • --shell-init は何度実行しても安全です（マーカーコメントを使って既存の関数を更新します）
  • 関数は環境から検出された絶対パスを使用します
  • Windows: シェル統合はPowerShellのみ対応しています。CMDはシェル関数の機能がないため、Unity起動後の自動 cd ができません

セキュリティ

このプロジェクトはサプライチェーン攻撃対策を実装しています：

  • ignore-scripts: npm install 時のスクリプト自動実行を無効化
  • @lavamoat/allow-scripts: パッケージのインストールスクリプト実行を明示的に制御
  • Dependabot: 週次の自動セキュリティアップデート
  • Security audit CI: PR ごとに npm audit、lockfile-lint、OSV-Scanner を実行
  • Pinned versions: すべての依存関係で正確なバージョンを指定（^ や ~ なし）

ライセンス

MIT