ptm-cli

project template manager cli

一款对项目模板/项目进行管理的脚手架工具，具有添加模板/项目、编辑模板/项目、删除模板/项目、查看模板/项目以及下载项目和根据模板初始化项目等功能。

特点

• ptm-cli兼容github和码云；

  现在很多自行开发的脚手架都是都只能对github上模板/项目进行下载，随着国内码云的发展壮大，国内开发者很多也在码云上进行代码管理；目前现有的脚手架轮子中并没有兼容码云的（至少本人没发现）！

• 管理功能全；

  大多数脚手架只对某一个模板进行初始化下载，只具备指定初始化功能；ptm-cli能够对模板和项目进行管理，不仅可以自由添加删除开源的优秀项目（例如vue），还可以添加删除编辑自己开发的项目模板；

安装

$ npm install ptm-cli -g

命令语句

1、基础帮助命令

安装完在电脑终端输入相应命令查看和执行相关操作。

# 查看脚手架可执行的相关命令语句
$ ptm 

# 查看当前版本
$ ptm -V

# 查看帮助
$ ptm -h

2、添加模板/项目

输入命令：

$ ptm-add

根据终端提示输入相关信息：

模板名：添加的模板自定义命名（建议使用引文）；

url：模板/项目在github或者码云上的https/ssh克隆地址链接；

branch：模板/项目所在github或者码云上的分支名（默认master）；

delGitInfo：是否删除模板/项目中的原作者git的开发信息（默认true删除），对于模板管理建议默认设置为true，即初始化模板不含有其他让人的git信息，对于项目管理（自己项目）建议保留自己开发相关的git信息；

description：模板/项目的描述信息（默认为空）；

例子：

xxx % ptm-add  
? 请输入模板名称 vpblogs
? 请输入模板地址（https/ssh） [email protected]:goodloving/vpblogs.git
? 请输入模板分支（默认master） master
? 是否删除模板中.git信息（默认删除） true
? 请输入模板描述(默认为空) 基于vuepress创建个人博客主页的模板工程

添加模板成功！

最终的模板列表为：
   vpblogs
     url：[email protected]:goodloving/vpblogs.git
     branch：master
     description：基于vuepress创建个人博客主页的模板工程
     delGitInfo：true
xxx % 

3、编辑模板/项目

输入命令：

$ ptm-edit templateName key content

根据终端提示输入相关信息：

templateName：本人添加过的模板/项目名；

Key：想要进行编辑的模板/项目的关键信息，包括：url、branch、delGitInfo、description；

content：对关键字对应内容进行编辑替代的内容；

例子（修改模板vpblogs的delGitInfo信息）：

xxx % ptm-edit vpblogs delGitInfo false

修改模板成功！

最终的模板列表为：
   vpblogs
     url：[email protected]:goodloving/vpblogs.git
     branch：master
     description：基于vuepress创建个人博客主页的模板工程
     delGitInfo：false
xxx % 

4、查看模板/项目

输入命令：

$ ptm-list

例子：

xxx % ptm-list

模板列表为：
   vpblogs
     url：[email protected]:goodloving/vpblogs.git
     branch：master
     description：基于vuepress创建个人博客主页的模板工程
     delGitInfo：false
xxx % 

5、删除模板/项目

输入命令：

$ ptm-del

例子：

xxx % ptm-del
? 请输入要删除的模板名称 vpblogs

删除模板成功！

最终的模板列表为：
xxx % 

6、基于模板新建/初始化项目

输入命令：

$ ptm-init vpblogs testPTM

例子（根据模板vpblogs新建项目testPTM）：

xxx % ptm-init vpblogs testPTM

开始创建项目~ 

✔ 正在创建中···

项目创建成功~ 

开始你的项目开发！
xxx % 

执行完成后在当前终端所在目录下可以看到名为testPTM的项目文件！