本文是Adapt 响应式课程开发框架系列第5篇文章,请点击下面的链接阅读该系列其他文章。
- Adapt 响应式课程开发框架(1): 简介
- Adapt 响应式课程开发框架(2): 内容结构
- Adapt 响应式课件开发框架(3): 插件结构
- Adapt 响应式课件开发框架(4): 安装Adapt (上)
- Adapt 响应式课件开发框架(4): 安装Adapt (下)
在上一篇文章中我们讨论了如何使用adapt-cli来安装Adapt,本文将为您详细介绍Adapt CLI (Adapt Command Line Interface),这个与Adapt响应式课件开发框架一起使用的命令行工具。
主要用途
Adapt-cli 的主要用途除了安装Adapt课件开发框架以外,还包括安装、更新和卸载adapt插件等功能。Adapt-cli通过引用Adapt插件注册表来实现这些功能,因此,adapt-cli 也包含一些插件注册表命令,一般只有专业的Adapt插件开发程序员才使用这些命令。
安装Adapt-cli
在安装adapt-cli之前,请确保系统中已经安装了NodeJS
和git
,然后运行下面的命令进行全局安装:
npm install -g adapt-cli
注意:在有些系统中进行全局安装也许需要在命令前添加sudo
常用命令
下面我向大家介绍一些课件开发人员常用的命令。对于那些仅由Adapt插件开发程序员使用的高级命令,请参见adapt-cli的github库。
adapt version
adapt version
在装有课件开发框架的课件项目根目录下运行该命令,显示当前安装的adapt-cli
和课件开发框架的版本号。如果没有在课件项目的根目录下运行该命令,课件开发框架版本号则显示为0.0.0
。
adapt help
adapt help [<command>]
这个命令有两种形式。仅运行adapt help
则显示所有Adapt命令,每个命令包含简短说明。

运行adapt help create
则显示一个关于create
这个命令的说明。
adapt create
adapt create [<type> <path> <branch>]
这是Adapt中最常用的一个命令,它包含以下三个可选参数,没有给出就使用默认值。
- type:创建什么类别 ,可选参数为
course
(课件)或component
(组件),没有给出则默认使用course
。 - path:新课件的路径。如果路径中包含空格,需使用引号。
- branch: 需要下载的课件开发框架分支,没有给出则使用主分支。
示例
adapt create course "My Course"
这将在当前工作目录中创建一个名为“My Course”的新课件目录,然后将Adapt课件开发框架代码从其主分支(包括默认示范课程)下载到这个新课件目录中。
adapt create course "My Course" develop
这个和上面的示例唯一不同之处就是Adapt课件开发框架源代码是从一个名为develop
的分支下载,而不是主分支。
adapt create component "test-component"
这个命令对于开发新组件很有用。它将在当前工作目录中创建一个名为“test-component”的新目录。它将使用Adapt组件所需的文件填充这个目录,并在相关的代码中插入“test-component”
adapt search
adapt search [<plug-in>]
使用这个命令来搜索Adapt插件注册表中的开源插件。<plug-in>名称为选填,没有给出则显示插件注册表中的所有Adapt开源插件。该命令支持模糊搜索,如以下搜索都会得到相同结果。
adapt search adapt-contrib-pageLevelProgress
或
adapt search contrib-pageLevelProgress
或
adapt search pageLevel
adapt install
adapt install <plug-in>[#|@<version>]
使用这个命令来安装一个Adapt插件。plug-in为插件名称,后面的#|@<version>为可选项,用来安装一个指定的插件版本。
示例
adapt install
,如果没有给出插件名称,则默认安装课件目录里adapt.json
中的所有插件。
adapt install adapt-contrib-pageLevelProgress
或 adapt install contrib-pageLevelProgress
则安装adapt-contrib-pageLevelProgress
插件,注意在第二个命令着省略了adapt-
的前缀。
adapt install adapt-contrib-pageLevelProgress@1.1.0
和adapt install contrib-pageLevelProgress#1.1.0
效果是一样的,都是安装插件adapt-contrib-pageLevelProgress
版本1.1.0
adapt uninstall
adapt uninstall <plug-in>
使用这个命令卸载某个已经安装的插件,如:adapt uninstall adapt-contrib-pageLevelProgress
adapt ls
adapt ls
显示课件项目目录下adapt.json
文件中的所有插件名称及版本号。
adapt update
adapt undate [<plug-in>[#|@<version>] [--check]
--check
仅检查是否有需要更新的版本,但不更新。
示例
adapt update
更新课件项目中adapt.json
文件中所有已安装的插件。
adapt update --check
检查课件项目中adapt.json
文件里所有已安装的插件是否有更新并列出,但不更新。
adapt update adapt-contrib-pageLevelProgress
更新adapt-contrib-pageLevelProgress
插件到最新版。
adapt update contrib-pageLevelPregress@1.1.0
将adapt-contrib-pageLevelProgress
插件更新到1.1.0
版。
以上这些就是adapt-cli里最常用的命令了,如果你习惯直接使用Adapt课件开发框架来开发课件,那adapt-cli绝对是必不可少的好帮手。
《Adapt 响应式课程开发框架》系列原创文章由我爱E-Learning电子学习社区独家发布,转载请署名并给出原文链接。
我要评论