目录
githubremotecreate: 一个为本地项目自动创建远端代码仓库的cli工具
githubremotecreate: 一个为本地项目自动创建远端代码仓库的cli工具
背景:在使用github时,发现若是在本地终端要创建github仓库,每次都要进入到 github主页,或者使用github cli很不方便。 话不多说,直接开始。
项目简介
一个为本地项目自动创建远端代码仓库的cli工具,它可以方便我们快速为本地项目创建一个空的远端仓库,以便我们把自己的本地代码推送到远端存储并共享给他人。
安装前的准备
- 新建一个项目文件夹,或者已有的现成项目代码。
- 配置你的github的access token,access token 可以参考下面的官方链接:
- 配置可以使系统全局的或者项目级别的局部配置
- 全局配置:系统安装git时的配置文件,里面包含登录用户配置信息,如我Mac中的配置地址是:~/.gitconfig。其中有个user的配置如下,name和token是必须的,具体如何配置可以参考git的用户配置方法:
[user]
name = denghuiquan
email = 980352129@qq.com
token = ghp_E**********************p4v
-
- 局部配置是在当前项目代码的根目录下,创建一个名为: .token.ini 文件,
-
[Github] access_token = ghp_E**********************p4v
- 同时为了不泄漏我们的账户token,需要同时创建或者在现有的 .gitignore 文件中添加一行以忽略该配置,不要把它push到远端仓库。
经过以上的配置,这样就可以安装并使用这个cli工具了
如何安装
npm i @huiquan.d/githubremotecreate
安装过后就可以使用了
如何使用
githubremotecreate
直接项目根目录下运行cli命令即可, 我本地的项目测试结果如下:
项目局部安装的的话需要使用 npx 来运行, 运行及过如下:
他会发现我们没有配置用户token,所以我这里配置我的系统及的gitp配置;再次运行:
我们的项目被初始化了,有个.git 目录,并为其添加了remote url:
并且添加了README.md文件,记录了我们生成的远端仓库的仓库名称及远端仓库地址。
之后就是正常的git操作,本地的编辑代码,编辑过后使用git status查看被修改过的内容有哪些,确认过后,使用git add . 命令添加下改内容,并执行git commit -am "xxxx"提交本次修改并简要描述。git push origin master就可以直接把当前项目推送到刚刚创建的远端仓库了。不会再提示我们没有找到远端仓库的问题。 完美!
总结
本文介绍了githubremotecreate这个小工具,可以方便我们将本地项目远端化,抛弃了传统的手工打开浏览器进行创建,再复制得到远端url,再回到项目中进行git init 和 git remote add git@xxx.git的手工操作。让一切在本地即可顺利完成,前提是需要你本地配置了github的access token。