[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