🍣
GitHubのリモートブランチを一撃で生成するコマンド
概要
GitHubでリポジトリを作成する際に、ブラウザから手動で操作するのは少し面倒です。この記事では、gh
CLI を使い、リポジトリを簡単にローカルから一発で作成し、リモートと連携する方法を解説します。
1. コマンドの基本構造
gh repo create
は GitHub CLI(gh
)のコマンドで、新しいリポジトリを作成するために使います。以下は、ローカルディレクトリからリモートリポジトリを作成し、リモートブランチを生成するためのコマンドです:
gh repo create <リポジトリ名> --public --source=. --remote=origin
2. 各オプションの解説
-
<リポジトリ名>
- 作成するリポジトリの名前を指定します。
- 省略すると、現在のディレクトリ名が使用されます。
-
--public
- リポジトリを公開設定にします(デフォルトは
--private
)。
- リポジトリを公開設定にします(デフォルトは
-
--source=.
- 現在のローカルディレクトリをリポジトリの内容として使用します。
-
.git
が初期化されていない場合、gh
が自動で初期化します。
-
--remote=origin
- 作成したリポジトリのリモートを
origin
という名前で登録します。
- 作成したリポジトリのリモートを
3. コマンドの実行例
現在のプロジェクトディレクトリ(例: my-awesome-project
)を GitHub に登録したい場合:
cd my-awesome-project
gh repo create my-awesome-project --public --source=. --remote=origin
これを実行すると以下が行われます:
- GitHub上に
my-awesome-project
というリポジトリが作成される。 - ローカルディレクトリが Git リポジトリとして初期化されていない場合、初期化される。
- リモートリポジトリが
origin
として登録される。
4. より便利な使い方
デフォルト設定を利用する
リポジトリ名を省略すれば、現在のディレクトリ名が自動的にリポジトリ名として使用されます:
gh repo create --public --source=. --remote=origin
SSH の設定
リモート URL を SSH にしたい場合は、以下のコマンドを実行してください:
gh repo create <リポジトリ名> --public --source=. --remote=origin --clone
5. GitHub CLI の事前準備
gh
を使用する前に、以下の手順でセットアップを済ませてください:
-
GitHub CLI のインストール
- macOS:
brew install gh
- Windows:
GitHub CLI公式サイトからインストーラをダウンロード。
- macOS:
-
ログイン
gh auth login
-
SSH 設定(任意)
GitHubにSSHを設定済みであれば、HTTPSではなくSSHでのリモート登録が可能です。
まとめ
gh repo create
を使えば、リポジトリ作成とリモートブランチの登録を一撃で完了させることができます。特に既存のプロジェクトを素早くGitHubにアップロードしたいときに役立つコマンドです。ぜひ試してみてください!
Discussion