ccmd-cli

@ccmd-core 组织是一个年轻团队组成的开源组织，寓意旋律之主。ccmd-core-cli 是由组织内@六弦 @wxydesign 开发的命令行集成管理工具，它的能力来源于它集成的外部套件。

一个强大的、便捷的命令行集成管理工具，支持插拔式的命令工具集成，拥有完善的文档，支持自定义套件开发与集成。

背景故事

小明是某大厂的程序员，他善于使用各种命令行工具来实现他的某些需求———但随着公司以及社区的命令行工具安装的越来越多，他开始烦恼于如何记忆他们、管理他们； 而小明正在烦恼的时候，却不知道隔壁业务线又产出了新的命令行工具。

• 小明期望有一个统一的入口，来集成和管理所有命令
• 小明期望能方便的统一观察所有公司内产出的命令行工具，而不是单独的一个个了解它们

而小明期望的，就是ccmd-core-cli的存在意义。

快速使用

node版本支持: >=8.0.0 本地需要安装yarn

    # 安装
    yarn global add ccmd-core-cli
    # 运行 ccmd 命令 即可查看帮助和文档

概念

命令行管理工具

ccmd-cli，是用来管理命令行工具的命令行工具。这么说可能有点绕，也许下面的两个例子可以让你明白：

http-server 是一个比较知名的开源包，我们经常使用它来启动一个http-server服务。

    # 它当然也可以作为ccmd的套件。我们首先安装它
    ccmd install http-server
    # 这时我们运行ccmd发现, 已经拓展了http-server命令
    ccmd

    🎵 ccmd-core-cli版本检索完毕
    Usage: ccmd [options] [command]

    Options:
    -V, --version      output the version number
    -v, --version      查看当前版本
    -h, --help         display help for command

    Commands:
    search             列出官方所有套件
    list               列出已安装的套件列表
    install <package>  安装套件
    remove <package>   删除套件
    update [package]   更新套件
    desc  <package>    更改套件描述
    http-server        未知套件, 您可以通过命令 ccmd des <pluginName> <description> 来更改它的描述
    help [command]     display help for command
    
    # 我们可以更改对它的描述以便对它进行管理
    ccmd desc http-server

    > 用来启动http服务的套件。
    # 我们可以通过 ccmd http-server来运行它的相关功能
    ccmd http-server -h

    # 在当前目录下启动一个http-server服务。
    ccmd http-server -c

特性

• 自动化管理自身 - 每次运行ccmd-cli时，它会告诉你是否需要更新它。
• 插拔式管理套件 - 方便的集成和管理套件。
• 关注点分离 - ccmd-cli与套件之间几乎是完全解耦的，每个套件都可以是独立的。

基础命令

| 命令 | 描述 | 具体使用 | 补充 | | -- | ----- | ----- | -------------| | ccmd search | 查询官方套件列表 | ccmd search | 列出所有ccmd-cli官方套件 | | ccmd list | 查询已安装套件列表 | ccmd list| 列出所有已安装的套件 | | ccmd install | 安装套件 | ccmd install | package必填 | | ccmd remove | 删除套件 | ccmd remove | package必填 | | ccmd update | 更新套件 | ccmd update [package] | 不填参数时，默认更新所有ccmd-cli套件 | | ccmd desc | 更改套件的描述 | ccmd desc | package必填, 例: ccmd desc http-server |

外界套件

理论上任何全局包，都可以作为ccmd的插件。 比如 http-server是一个启动http-server服务的包,我们可以通过ccmd去安装/管理/使用它

    # 安装
    ccmd install http-server
    # 查看命令里 已拓展了http-server
    ccmd -h
    # 查看http-server的使用帮助
    ccmd http-server -h 
    
    # 我们可以给它加一个描述
    ccmd desc http-server
    >请输入对http-server的描述:
    ： 用来启动http服务的包。

    # 当前目录下使用它启动一个http-server服务
    ccmd http-server -c 

使用开发模式来调试您的套件

在你进入了项目的根目录后，即开启ccmd套件开发模式

    # 前置，在自定义套件项目的根目录下
    node ./index.js
    # 这时候你就能在test命令分类下查看到您自定义的套件命令，并可以运行它

发布套件

    # 套件项目根目录下运行：
    ccmd publish 

开发文档

commander

如果你想开发套件，甚至参与ccmd-cli的开发，建议你先玩一下commander，因为ccmd-cli和套件原则上都是基于它开发的。 它的官方文档地址： https://github.com/tj/commander.js/blob/HEAD/Readme_zh-CN.md