<div id="readability-page-1" class="page"><div itemprop="articleBody">
            

            

            

            <p><img src="https://www.setvalue.net/static/7e5c549b6e41f51fabb6960f14b7e841/73822/GitHub-CLI.jpg"></p>
<p>지난해 Github에서 커맨드라인에서 사용가능한 Github CLI를 릴리즈했다. 형상관리는 당연히 커맨드라인에서도 할 수 있는데, 형상관리를 넘어서서 원격저장소를 생성하거나 이슈 등록, PR 등 웹에서 지원하는 기능들을 커맨드라인에서 할 수 있는 툴을 공개한 것이다.</p>
<p>아직 익숙하지 않은 툴이어서 연습도 해볼겸 <a target="_blank" rel="noopener" href="https://firstcontributions.github.io/">FirstContributions</a>라는 오픈소스에 문서작성으로 기여를 하려고 했다. 그러나 리뷰까지 다 받았음에도 Merge 해주지 않으셔서 한글로 다시 번역해서 블로그에 공개키로 결정했다. </p>
<p><a target="_blank" rel="noopener" href="https://cli.github.com/manual/">공식문서</a>가 굉장히 잘되어 있기 때문에 사실 본 포스팅을 보는 대신 그냥 공식문서를 보는게 더 나을지도 모른다. <strong>본 포스팅은 Github CLI의 모든 명령어를 정리하기 보다는 컨트리뷰션에 기여하는 방법을 정리한 포스팅이다.</strong></p>
<p>Github CLI를 사용하기 위해서는 당연하게도 터미널이 필요하다. 본 포스트는 <a target="_blank" rel="noopener" href="https://iterm2.com/">iTerm2</a>를 기반으로 작성되었다.</p>
<h3 id="ToC"><a href="#ToC" title="ToC"></a>ToC</h3><ul>
<li><a href="#install">Github CLI 설치하기</a></li>
<li><a href="#auth">Auth 등록하기</a></li>
<li><a href="#fork">레포지토리 포킹(Fork)</a></li>
<li><a href="#commit">커밋 생성 및 푸쉬</a></li>
<li><a href="#issue">이슈 등록하기</a></li>
<li><a href="#pr">PR 생성하기</a></li>
</ul>
<hr>
<br>

<h2 id="Github-CLI-설치하기"><a href="#Github-CLI-설치하기" title="Github CLI 설치하기"></a><a name="install">Github CLI 설치하기</a></h2><p>Reference : <a target="_blank" rel="noopener" href="https://github.com/cli/cli#installation">Github CLI - Installation</a></p>
<ul>
<li><h3 id="공식-웹페이지에서-설치하기"><a href="#공식-웹페이지에서-설치하기" title="공식 웹페이지에서 설치하기"></a>공식 웹페이지에서 설치하기</h3><ul>
<li><a target="_blank" rel="noopener" href="https://cli.github.com/">Github CLI 공식 웹 페이지</a>에서 설치할 수 있다.</li>
</ul>
</li>
<li><h3 id="Homebrew-MacOS-Linux"><a href="#Homebrew-MacOS-Linux" title="Homebrew (MacOS, Linux)"></a>Homebrew (MacOS, Linux)</h3><ul>
<li><p>Mac이나 리눅스 사용자라면, 홈브루를 통해서도 설치할 수 있다.</p>
</li>
<li><pre><code> brew install gh
 <figure><table><tbody><tr><td><pre><span>1</span><br><span>2</span><br><span>3</span><br><span>4</span><br><span>5</span><br></pre></td><td><pre><span></span><br><span>- 설치가 되었다면 아래처럼 버전확인을 할 수 있다.</span><br><span></span><br><span>- ~~~</span><br><span>   gh --version</span><br></pre></td></tr></tbody></table></figure></code></pre>
</li>
<li><img src="https://user-images.githubusercontent.com/33862991/123590149-39338780-d825-11eb-8293-b730bb3e6c9e.png" alt="Github CLI version">

</li>
</ul>
</li>
</ul>
<br>

<h2 id="Auth-등록하기"><a href="#Auth-등록하기" title="Auth 등록하기"></a>Auth 등록하기</h2><p>Reference : <a target="_blank" rel="noopener" href="https://cli.github.com/manual/gh_auth_login">Github CLI - gh auth login</a></p>
<p>Github CLI를 사용하기 위해서는 Github 계정 인증(Authentication)을 받아야한다.</p>
<p>인증하는 방식은 두가지로 구분된다.</p>
<ul>
<li>웹으로 인증하기</li>
<li>토큰 이용하기</li>
</ul>
<p>디폴트는 웹으로 인증하는 방식으로 되어있으므로 본 포스트도 웹으로 인증하는 방식을 소개하겠다. </p>
<p><img src="https://user-images.githubusercontent.com/33862991/127286187-f4a900bf-4519-4828-b4a1-646b26b4fd8c.png"></p>
<p>Github.com을 선택하고 엔터를 입력한다.</p>
<p><img src="https://user-images.githubusercontent.com/33862991/127287855-80264cba-5d12-4e43-bfe0-5671b6b8f8bd.png"></p>
<p><img src="https://user-images.githubusercontent.com/33862991/127287858-60a17269-2e2f-4141-8a28-729d7068a0ae.png"></p>
<p>여기서 인증방식을 선택할 수 있다. 본 포스팅은 웹 브라우저를 통한 인증방식을 기반으로 작성한다. </p>
<p>웹 브라우저를 통해 인증하기 때문에 브라우저에서 Github에 로그인이 되어있어야 한다.</p>
<p><img src="https://user-images.githubusercontent.com/33862991/127287862-8b8967ae-a3ef-4b93-b2eb-74e255fd978f.png"></p>
<p>여기까지 완료되면, 로그인을 위한 일회용 코드가 발급된다. 엔터를 입력하면 브라우저에서 이 일회용 코드를 입력하는 창이 열린다.</p>
<p><img src="https://user-images.githubusercontent.com/33862991/127287868-3a228db3-b26f-4d99-b14d-e0e80d95d31f.png"></p>
<p>발급받은 코드를 입력하고, 이제부터 웹 브라우저에서 Github CLI 인증에 필요한 작업을 진행한다.</p>
<p><img src="https://user-images.githubusercontent.com/33862991/127287872-6dc1c163-3e17-4679-86d3-545f0a03c646.png"></p>
<p>인증 권한을 확인한다.</p>
<p><img src="https://user-images.githubusercontent.com/33862991/127287877-67644905-3b16-4cf9-b7cb-491a6b4aa346.png"></p>
<p>웹 브라우저에서 Github CLI에 대한 인증작업이 마무리되면 터미널에서도 인증이 끝난걸 확인할 수 있다.</p>
<p><img src="https://user-images.githubusercontent.com/33862991/127287880-ae83adf1-9dce-4e99-8e01-919ea45e1797.png"></p>
<br>

<h2 id="레포지토리-포킹-Fork"><a href="#레포지토리-포킹-Fork" title="레포지토리 포킹(Fork)"></a><a name="fork">레포지토리 포킹(Fork)</a></h2><p>Reference : <a target="_blank" rel="noopener" href="https://cli.github.com/manual/gh_repo_fork">Github CLI - gh repo fork</a></p>
<p>컨트리뷰션 대상 레포지토리를 내 Github 저장소로 포킹한다.</p>
<figure><table><tbody><tr><td><pre><span>1</span><br></pre></td><td><pre><span>gh repo fork [repository-owner]/[repository-name]</span><br></pre></td></tr></tbody></table></figure>

<p><img src="https://user-images.githubusercontent.com/33862991/123590154-3afd4b00-d825-11eb-91b0-99c28d87bfc7.png" alt="Fork repository via Github CLI"></p><p>그럼 위의 이미지처럼 포킹할 것인지를 묻는다. <code>Y</code>를 입력하면 포킹과 클론이 함께 진행된다.</p>
<p><img src="https://user-images.githubusercontent.com/33862991/123590161-3c2e7800-d825-11eb-8e28-f60ecb6b8be7.png" alt="Fork repository via Github CLI"></p><p>끝났다면, 레포지토리 리스트를 조회해서 방금 포킹한 레포지토리가 정상적으로 내 Github 계정의 레포지토리로 포크되었는지 확인하자. 그리고 로컬에도 레포지토리가 클론되었는지 확인하자.</p>
<figure><table><tbody><tr><td><pre><span>1</span><br></pre></td><td><pre><span>gh repo list</span><br></pre></td></tr></tbody></table></figure>

<p><img src="https://user-images.githubusercontent.com/33862991/123590165-3d5fa500-d825-11eb-98d0-a0d97fa6844c.png" alt="Repository List"></p><h2 id="커밋-생성-및-푸쉬"><a href="#커밋-생성-및-푸쉬" title="커밋 생성 및 푸쉬"></a><a name="commit">커밋 생성 및 푸쉬</a></h2><p>Reference : <a target="_blank" rel="noopener" href="https://git-scm.com/book/ko/v2/Git%EC%9D%98-%EA%B8%B0%EC%B4%88-%EC%88%98%EC%A0%95%ED%95%98%EA%B3%A0-%EC%A0%80%EC%9E%A5%EC%86%8C%EC%97%90-%EC%A0%80%EC%9E%A5%ED%95%98%EA%B8%B0">Git-scm - 2.2 Git의 기초, 수정하고 저장소에 저장하기</a></p>
<p>레포지토리가 성공적으로 포크와 클론이 마무리되었다면, 이제 커밋을 생성할 차례이다. 커밋을 만들기전 작업의 목적에 맞는 브랜치를 만들어서 커밋을 관리해보자.</p>
<p>브랜치를 생성한다.</p>
<figure><table><tbody><tr><td><pre><span>1</span><br></pre></td><td><pre><span>git branch [your-new-branch-name]</span><br></pre></td></tr></tbody></table></figure>

<p>생성된 브랜치로 현재의 브랜치를 변경한다.</p>
<figure><table><tbody><tr><td><pre><span>1</span><br></pre></td><td><pre><span>git switch [your-new-branch-name]</span><br></pre></td></tr></tbody></table></figure>

<p><img src="https://user-images.githubusercontent.com/33862991/123590170-3e90d200-d825-11eb-8c51-12e0f1c0f903.png" alt="Create branch and switch"></p><p>변경사항이 있다면, 이제 커밋을 만들면 된다.</p>
<figure><table><tbody><tr><td><pre><span>1</span><br></pre></td><td><pre><span>git commit -m "[commit-message]"</span><br></pre></td></tr></tbody></table></figure>

<p><img src="https://user-images.githubusercontent.com/33862991/123590172-3f296880-d825-11eb-9c06-1d362b1bd5ff.png" alt="Commit changes"></p><p>커밋까지 생성했다면 이제 원격저장소(cloned)에 커밋을 반영한다.</p>
<figure><table><tbody><tr><td><pre><span>1</span><br></pre></td><td><pre><span>git push --set-upstream origin [your-branch-name]</span><br></pre></td></tr></tbody></table></figure>

<p><img src="https://user-images.githubusercontent.com/33862991/123590173-3fc1ff00-d825-11eb-9980-66bb309f2c89.png" alt="Push changes into repository forked"></p>
<br>

<h2 id="이슈-등록하기"><a href="#이슈-등록하기" title="이슈 등록하기"></a><a name="issue">이슈 등록하기</a></h2><p>Reference : <a target="_blank" rel="noopener" href="https://cli.github.com/manual/gh_issue_create">Github CLI - gh issue create</a></p>
<p>Github에 이슈를 등록하는 방법이다.</p>
<figure><table><tbody><tr><td><pre><span>1</span><br><span>2</span><br><span>3</span><br></pre></td><td><pre><span>gh issue create -t "[Bug] need to be fix.."</span><br><span>gh issue create -l "bug, help wanted"</span><br><span>gh issue create -a @me</span><br></pre></td></tr></tbody></table></figure>

<p>issue를 등록할 때 사용하는 옵션 키워드는 아래와 같다.</p>
<table>
  <tbody><tr>
      <th>Command</th>
    <th>Option</th>
    <th>Definition</th>
  </tr>
  <tr>
      <td>-t</td>
    <td>--title</td>
    <td>이슈 제목</td>
  </tr>
  <tr>
      <td>-l</td>
    <td>--label</td>
    <td>라벨</td>
  </tr>
  <tr>
      <td>-a</td>
    <td>--assginee</td>
    <td>이슈 할당자</td>
  </tr>
</tbody></table>

<br>

<h2 id="PR-생성하기"><a href="#PR-생성하기" title="PR 생성하기"></a><a name="pr">PR 생성하기</a></h2><p>Reference : <a target="_blank" rel="noopener" href="https://cli.github.com/manual/gh_pr_create">Github CLI - gh pr create</a></p>
<p> 코드리뷰를 위한 PR을 생성하는 방법이다.</p>
<figure><table><tbody><tr><td><pre><span>1</span><br></pre></td><td><pre><span>gh pr create [repository-owner]/[repository-name]</span><br></pre></td></tr></tbody></table></figure>

<p><img src="https://user-images.githubusercontent.com/33862991/123590175-40f32c00-d825-11eb-92c5-af0e6ba637fd.png" alt="Source : Github CLI"></p>
<p>커맨드라인에서 원격 저장소에 올라온 PR 리스트를 확인할 수도 있다.</p>
<figure><table><tbody><tr><td><pre><span>1</span><br></pre></td><td><pre><span>gh pr list</span><br></pre></td></tr></tbody></table></figure>

<p><img src="https://user-images.githubusercontent.com/33862991/123590174-405a9580-d825-11eb-8c2a-e607d2aa192f.png" alt="PR List in console"></p>
<p>웹 브라우저에서 확인해보면 커맨드라이넹서 본 PR 리스트와 일치하는걸 확인할 수 있다.</p>
<p><img src="https://user-images.githubusercontent.com/33862991/123590177-40f32c00-d825-11eb-81e9-66a2a9d79e3b.png" alt="PR List in web view"></p>
<br>
        </div></div>

기록하는개발자 | DevAndy

DevAndy

지난해 Github에서 커맨드라인에서 사용가능한 Github CLI를 릴리즈했다. 형상관리는 당연히 커맨드라인에서도 할 수 있는데, 형상관리를 넘어서서 원격저장소를

Github CLI 맛보기

댓글