0.0.4 • Published 6 years ago
gl-issue v0.0.4
gitlab-issue小工具
用途
有的人喜欢在gitlab的issue上搭建自己的博客,该工具用于将自己issue上的博客都下载到本地。
安装
npm i -g gl-issue
使用
首先要初始化配置基础信息
gl-issue init // (重要)进行一些初始化配置,填写你的项目地址,private token等信息
可以调用 gl-issue config --help 查看需要配置的内容对应的详情, gl-issue config 查看已经配置好的信息,检查是否有误。
gl-issue config --help
// 以下是输入的内容
各个配置及其说明:↓↓↓↓↓↓↓↓
GITLAB_WEB 你们公司部署的gitlab线上域名
PROJECT_API 请求project的api, 默认是/api/v3/projects, 可以查看gitlab文档修改
PROJECT_ID issue项目的id
PRIVATE_TOKEN 个人gitlab的private token或者access token
USEIDINFILENAME 是否开启文件名后面添加issue的id,主要为了防止重名,默认关闭
GITLAB_IMAGE_URL issue中图片上传的地址域名, 默认是gitlab域名
- issue项目的id就是你博客项目的id,如果不知道则直接输入项目的全称,会自动查找。
- USEIDINFILENAME 主要是防止多个issue的title相同,导致写入到本地的时候出错。最好能自己保证title不重复。
修改单个配置的命令:
gl-issue set PROJECT_ID 123
下载全部的issue文章:
gl-issue dl [filename]
filename为文章下载后存放的文件名,默认为 issueArticle 。
下载单个issue文章
gl-issue dl -s [issueId]
issueId为issue创建时候的id,这个可以打开自己要下载的线上的issue,链接后面的数据就是issue的id,比如下面的这个url:
gitlab.admin.com.cn/document/issues/3
3 就是issueId。
待完成
- 本地issue的上传
- 默认添加头部信息的可配置化