gji をインストールする
CLI をインストールしたら、シェル連携を一度だけ設定します。これにより、gji new、gji go、gji back が現在のシェルのディレクトリを変更できるようになります。
必要なもの
- npm パッケージを実行するための Node.js 20+。
- ワークツリーをサポートする Git と、作業するローカルリポジトリ。
- ディレクトリを自動で移動するための zsh、bash、または fish。
- ブランチやプルリクエストを取得するための、Git リモートへのアクセス権。
対応するロックファイルが見つかると、新しいワークツリーに依存関係をインストールします。プロジェクトのパッケージマネージャが使用可能である必要があります。初回のインストールには時間がかかることがあり、追加のディスク容量も使います。--no-install で省略できます。
インストールとシェルの設定
npm install -g @solaqua/gji
gji init
ウィザードがシェル連携と補完をインストールし、使用できるエディタの選択を案内します。先へ進む前に、シェルを再起動するか、ウィザードが示した設定ファイルを読み込んでください。
リポジトリ内で結果を確認します。
gji doctor
シェル、Git、設定に関する案内に従ってください。その後、最初のワークツリーを作成します。
使用するシェルを指定する
dotfiles や非対話環境を設定する場合は、次のコマンドを使います。
gji init zsh --write
# Or use your shell:
gji init bash --write
gji init fish --write
使用するシェルのコマンドだけを実行してください。ファイルに書き込まず、まずラッパーを確認する場合は次のようにします。
gji init zsh
現在のセッションだけでの設定やスクリプトからの利用については、シェル連携をご覧ください。連携なしでもワークツリーのコマンドでディレクトリを作成したり取得したりできますが、親シェルを移動させることはできません。
任意:ローカルのプロジェクトファイルを準備する
新しいワークツリーで メインワークツリー の非公開ファイルが必要な場合は、登録してください。
gji sync-files add .env.local .npmrc
ファイル一覧は、グローバル設定のリポジトリ別の項目に保存されます。新しいワークツリーには依存関係のセットアップ前にファイルがコピーされます。コピー先にある既存ファイルは上書きしません。ローカルファイルをご覧ください。
コード生成など、追加のプロジェクト設定にはフックを使ってください。組み込みのアダプタが依存関係をインストールしている場合、別のインストールフックを追加する必要はありません。
更新する
npm install -g @solaqua/gji
シェルを再起動して連携を読み込み直し、gji doctor をもう一度実行してください。移動せずにパスだけが表示される場合は、移動に関するトラブルシューティングを確認してください。