简介
gist-hub 是一款可以快速创建、编辑、删除 GitHub Gist 的 npm 包。使用 gist-hub 可以不用在 GitHub 存储库中给特定的 Gist 进行指定。您可以使用名为的Gist-File命令功能提交本地文件,这些文件将自动创建新 Gist 并将其提交到GitHub,而无需访问 GitHub 网站。
前置条件
在使用 gist-hub 之前,确保您已完成以下操作:
- 安装 Node.js (Node.js 版本需不低于 10.0.0)
- 在 GitHub 上创建并设置了访问令牌 Token
安装
使用以下命令全局安装 gist-hub:
npm install -g gist-hub
使用
打开终端并使用 gist-hub
命令加选项指定需要执行的操作。以下是 gist-hub 的常用操作:
创建 Gist
gist-hub create "Gist Name" "Gist Description" file1.txt file2.js
create
命令可以接受多个文件,这些文件将被打包在一个 Gist 中。您可以指定 Gist 的名称和描述,文件名也将自动设置为 Gist 文件名。
编辑 Gist
gist-hub edit GistID file1.txt file2.js
edit
命令可以接受多个文件,并将这些文件更新到指定的 Gist 中。
删除 Gist
gist-hub delete GistID
delete
命令将删除指定的 Gist。
获取 Gist
gist-hub show GistID
show
命令将显示指定 Gist 的详细信息。
列出自己的 Gist
gist-hub list
list
命令将显示您所有的 Gist 列表。
列出其他人的 Gist
gist-hub list username
list
命令也可以用于显示其他人的 Gist 列表。
示例
以下是 gist-hub 的示例,用于创建一个包含两个文件(index.html 和 index.js)的新 Gist 并在 GitHub 上显示。
gist-hub create "My First Gist" "This is my first Gist" index.html index.js
输出将显示包含 Gist ID 和地址的信息。
Gist created with Id: 6b27899fdea8a7b01dbd2ee2527e08a5 Gist URL: https://gist.github.com/<username>/6b27899fdea8a7b01dbd2ee2527e08a5
注意事项
- 在创建或更新 Gist 时,您仍需要过 GitHub 的身份验证。如果您未提供访问令牌 Token,则会提示您输入 GitHub 用户名和密码。
- 在创建 Gist 时,如果不提供文件名,则文件将被命名为 Gist 名称加上
-
和数字。例如My First Gist-1.txt
。
总结
在这篇文章中,我们学习了 npm 包 gist-hub 的使用教程。 gist-hub 是一款高效的工具,可以在不访问 GitHub 网站的情况下创建、编辑和删除 Gist。默认情况下,如果您未提供访问令牌 Token,则会提示您输入 GitHub 用户名和密码以完成身份验证。
参考
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055bc181e8991b448d95ab