マニュアル: ghq

投稿日: 更新日:

入れておいたほうがいいもの

  • peco/fzf: 標準出力をインタラクティブに検索
  • hub: githubをコマンドラインから扱うためのラッパー
  • github-list-starred: スターを付けたリポジトリをリスト

macOSの場合、どちらもbrewコマンドで入れられます。 以下の記事を参考にしました。

初期設定

  • GHQ_ROOT: ghqがcloneするパス。
    • 自分は~/srcにセットしました。
  • GITHUB_USER: GitHubのユーザID
    • デフォルトではOSのユーザIDとなるので、違う場合のみ。
  • github-list-starredの設定
git config --global ghq.import.starred github-list-starred

基本的な使い方

リポジトリの追加

getコマンドでclone/syncします。

ghq get https://github.com/motemen/ghq

importコマンドでまとめて取得します。

ghq import starred ikemo3

リポジトリの表示

listコマンドでローカルリポジトリの一覧を表示します。

ghq list

リポジトリの検索

リポジトリにcdして、シェルを起動します。 ヘルプはghq look --helpで出ます。

ghq look <project>
ghq look <user>/<project>
ghq look <host>/<user>/<project>