[Github Cli] 自動化倉庫創建:不訪問網站即可設置項目

學習如何運用 Github Cli 在不需造訪 Github 網站的情況下建立倉庫。遵循此指南,優化您的工作流程,提升專案管理技巧。

安裝 Github Cli

Github Cli 是一款將 Github 帶入您的終端的命令行工具。以下是安裝方式:

在 macOS 上

bash
brew install gh

在 Windows 上

bash
scoop install gh

在 Linux 上

bash
sudo apt install gh

以上指令將在您的系統上安裝 Github Cli。

建立倉庫

利用 Github Cli,建立新倉庫簡單無比。請遵循以下步驟:

1. 認證

首先,執行以下命令對您的 Github 帳戶進行認證:

bash
gh auth login

2. 建立新倉庫

您可以使用以下指令建立新倉庫:

bash
gh repo create my-new-repo --public

輸出:

bash
✓ Created repository user/my-new-repo on GitHub

此指令將在您的帳戶下建立名為 'my-new-repo' 的公共倉庫。

3. 推送程式碼

將程式碼推送至新建的倉庫,請使用以下指令:

bash
git push origin main

此指令將程式碼推送至 'main' 分支。

利用 Github CLI 自動化專案建立

建立新專案通常需要進行多項重複性任務,如建立新目錄、初始化 Git 倉庫,以及連接到 Github。為了簡化這些任務,我們開發了針對 macOS、Linux 和 Windows 的自動化腳本。這些腳本將多個步驟結合成一步,提供快速啟動新專案的便捷方法。

使用腳本的優勢

  1. 節省時間: 無需手動建立目錄或初始化倉庫。
  2. 一致性: 確保每個專案都遵循相同的設置和結構。
  3. 易用性: 簡單的指令可執行多個設置步驟。
  4. 跨平台: 為 macOS、Linux 和 Windows 提供獨立腳本,以適應不同的環境。

macOS 和 Linux 的自動化腳本

對於 macOS 和 Linux 用戶,以下 bash 腳本簡化了建立專案目錄、初始化本地 Git 倉庫、建立對應的私有 Github 倉庫,並將它們連接的過程。

bash
#! /bin/bash

echo '在目前資料夾內建立專案,並連接到 Github。'
echo '請輸入專案名稱:(按 "Enter" 取消)'
read PROJECT_NAME

if [ ! -n "$PROJECT_NAME" ]; then
  exit 1
fi

LOCAL_PATH=$(pwd)/$PROJECT_NAME

echo $LOCAL_PATH "正在此路徑建立專案。如果正確,輸入 'yes',其他按鍵則取消"
read CREATE

if [ -n "$CREATE" ]; then
  if [ $CREATE == yes ]
  then
    # 建立私有 Github 倉庫
    gh repo create $PROJECT_NAME --private

    # 建立本地專案
    mkdir "$LOCAL_PATH"
    cd "$LOCAL_PATH"
    echo "# "$PROJECT_NAME >> README.md

    # 初始化 Git,並連接到 Github
    git init
    git remote add github [email protected]:USERNAME/$PROJECT_NAME
    git add .
    git commit -m "initial commit"
    git push github master
  fi
fi

執行腳本

  1. 儲存腳本至以 .sh 為延伸名的檔案,例如 create-project-with-git.sh
  2. 開啟終端。
  3. 導航至您想建立新專案的目錄。
  4. 導航至您想建立專案資料夾的位置,然後執行完整路徑以執行腳本。例如,輸入 sh /path/to/your/script/create-project-with-git.sh
  5. 跟隨終端中的提示進行操作。

範例

bash
cd /path/to/your/project/directory
sh /path/to/your/script/create-project-with-git.sh

Windows 的自動化腳本

Windows 用戶可利用 PowerShell 腳本實現相同功能。此腳本負責在本地建立專案並連接到 Github。

powershell
# 提示輸入專案名稱
Write-Host '在目前資料夾內建立專案,並連接到 Github。'
Write-Host '請輸入專案名稱:(按 "Enter" 取消)'
$PROJECT_NAME = Read-Host

if ([string]::IsNullOrWhiteSpace($PROJECT_NAME)) {
    exit
}

$LOCAL_PATH = (Get-Location).Path + "/" + $PROJECT_NAME

Write-Host $LOCAL_PATH "正在此路徑建立專案。如果正確,輸入 'yes',其他按鍵則取消"
$CREATE = Read-Host

if ($CREATE -eq 'yes') {
    #

 建立私有 Github 倉庫
    gh repo create $PROJECT_NAME --private

    # 建立本地專案
    mkdir $LOCAL_PATH
    Set-Location $LOCAL_PATH
    echo "# "$PROJECT_NAME > README.md

    # 初始化 Git,並連接到 Github
    git init
    git remote add github [email protected]:USERNAME/$PROJECT_NAME
    git add .
    git commit -m "initial commit"
    git push github master
}

執行腳本

  1. 儲存腳本至以 .ps1 為延伸名的檔案,例如 create-project-with-git.ps1
  2. 開啟 PowerShell。
  3. 導航至您想建立新專案的目錄。
  4. 導航至您想建立專案資料夾的位置,然後執行完整路徑以執行腳本。例如,使用 PowerShell 輸入 C:\path\to\your\script\create-project-with-git.ps1
  5. 跟隨 PowerShell 中的提示進行操作。

範例

powershell
cd "C:\path\to\your\project\directory"
C:\path\to\your\script\create-project-with-git.ps1

這些自動化腳本不僅僅是方便,對於希望優化工作流程並在不同專案之間保持一致性的開發者來說是不可或缺的工具。將這些腳本整合到您的開發流程中,您可以更專注於編程,減少繁瑣的設置任務,從而提高整體生產力。


總之,Github Cli 簡化了創建和管理倉庫的過程,無需訪問 Github 網站。它有助於優化開發工作流程,提供了提升專案管理技巧的絕佳方式。


常見問題

  1. Github Cli 是否適用於所有平台? 是的,Github Cli 可在 macOS、Windows 和 Linux 上使用。
  2. 我能使用 Github Cli 創建私有倉庫嗎? 當然可以。在倉庫建立命令中,將 --public 替換為 --private
  3. 如何使用 Github Cli 複製倉庫? 使用命令 gh repo clone <repository> 來複製倉庫。
  4. 我能使用 Github Cli 管理問題和拉取請求嗎? 是的,Github Cli 允許您從命令行管理問題和拉取請求。
  5. Github Cli 是否免費使用? Github Cli 是一個開源工具,可免費使用。
© Copyright 2023 CLONE CODING