.gitignoreをコマンドで作成する

Posted at 2024-08-05

本記事では.gitignoreをコマンドで作成する方法について説明する．githubなどのリモート上でgitignoreを作成することはできるが，コマンドを用いて.gitignoreを作成することができる．ローカルリポジトリを作成し，リモートリポジトリと紐付ける際に使おう．

ローカルリポジトリにgitignoreを追加する

curl -L http://www.gitignore.io/api/<作成したいgitignoreテンプレート> > .gitignore

例えばunityの.gitignoreを作成したい際は，

curl -L http://www.gitignore.io/api/unity > .gitignore

PythonとVisualStudioCodeの.gitignoreを作成したい際は，

curl -L http://www.gitignore.io/api/python,visualstudiocode > .gitignore

このコマンドを実行するとローカル上に.gitignoreを作成できる．

githubCLIのインストールが入っていない人はインストールすること

brew install gh

gh auth login

GitHub.comかGitHub Enterprise Serverかを選択する．個人利用ならGitHub.comを選択すれば良い，

? What account do you want to log into?  [Use arrows to move, type to filter]
> GitHub.com
  GitHub Enterprise Server

HTTPSかSSHを選択する

? What is your preferred protocol for Git operations on this host?  [Use arrows to move, type to filter]
> HTTPS
  SSH

Yと入力してEnter

? Authenticate Git with your GitHub credentials? (Y/n)

Login with a web browserで良いと思う．ブラウザでgithubへログインすることになる．

? How would you like to authenticate GitHub CLI?  [Use arrows to move, type to filter]
> Login with a web browser
  Paste an authentication token

その後，以下のように表示されるのでone-time codeを控えておく．

0000-0000は英数字で表示され，ユーザ，タイミングによって異なる値である．

! First copy your one-time code: 0000-0000
Press Enter to open github.com in your browser...

web上でone-time codeを入力し，githubにログインすると以下のように表示される．

✓ Authentication complete.
- gh config set -h github.com git_protocol https
✓ Configured git protocol
✓ Logged in as <githubアカウント名>

このコマンドでリモートに新しくgitignoreを追加した状態でリモートリポジトリを作成する．

プライベートリポジトリなら

gh repo create <リモートリポジトリ名> --private --gitignore <作成したいgitignoreテンプレート>

パブリックリポジトリなら

gh repo create <リモートリポジトリ名> --public --gitignore <作成したいgitignoreテンプレート>

Unityのgitignoreを追加したい

gh repo create <リモートリポジトリ名> --private --gitignore Unity

これだと1つのテンプレートしかできないので注意．2つ以上のテンプレートを組み合わせてgitignoreを作成できない

自分のGithubアカウントに紐付いた組織アカウントにリモートリポジトリを作成するなら

プライベートリポジトリなら

gh repo create <組織アカウント名>/<リモートリポジトリ名> --private --gitignore <作成したいgitignoreテンプレート>

この時点でgithubにアクセスすると自分のリポジトリに作成したものが反映されているはずである．

この先,ローカリリポジトリとリモートリポジトリの関連付けの方法については以下の記事から

gh browse

以下のコマンドを実行するとローカルリポジトリに結びついたリモートリポジトリにアクセスできる．
Macでは

open $(git remote get-url origin)

Windowsでは（PowerShellで）

start (git remote get-url origin)