Cri项目技术文档

1. 安装指南

Cri 是一个用于构建易于使用的命令行工具的库，支持嵌套命令。在安装 Cri 之前，请确保您的系统中安装了 Ruby 2.6 或更新版本。

安装 Cri 非常简单，您可以使用 Ruby 的包管理器 gem 进行安装：

gem install cri

确保遵循官方支持的 Ruby 版本政策， Cri 支持所有官方支持的 Ruby 版本，以及默认安装在：

• 近两个 Ubuntu LTS 版本上的 Ruby 版本
• 近两个主要 macOS 版本上的 Ruby 版本

2. 项目使用说明

Cri 的核心概念是 命令，它具有选项定义以及实际执行自己的代码。在 Cri 中，命令行工具本身也是一个命令。

以下是一个命令定义的示例：

command = Cri::Command.define do
  name        'dostuff'
  usage       'dostuff [options]'
  aliases     :ds, :stuff
  summary     '执行一些操作'
  description '这个命令会执行很多操作。我确实是这个意思。'

  flag   :h,  :help,  '显示此命令的帮助信息' do |value, cmd|
    puts cmd.help
    exit 0
  end
  flag   nil, :more,  '执行更多的操作'
  option :s,  :stuff, '指定要执行的操作', argument: :required

  run do |opts, args, cmd|
    stuff = opts.fetch(:stuff, '通用操作')
    puts "执行 #{stuff}！"

    if opts[:more]
      puts '执行得更多！'
    end
  end
end

要运行这个命令，请使用原始参数调用 #run 方法。例如，对于根命令（命令行工具本身），命令可以这样调用：

command.run(ARGV)

每个命令都会自动生成帮助信息。使用 Cri::Command#help 可以打印此帮助信息，显示如下：

用法: dostuff [选项]

执行一些操作

此命令会执行很多操作。我确实是这个意思。

选项：

    -h --help      显示此命令的帮助信息
       --more      执行更多的操作
    -s --stuff     指定要执行的操作

3. 项目API使用文档

Cri 提供了一系列的方法来定义命令和选项。以下是一些主要方法的简要说明：

• Cri::Command.define：定义一个新的命令。
• name：设置命令的名称。
• usage：设置命令的用法。
• aliases：设置命令的别名。
• summary：设置命令的简短摘要。
• description：设置命令的详细描述。
• flag：定义一个标志（没有参数的选项）。
• option：定义一个选项。

每个命令定义都包含一个 run 块，该块会在命令执行时运行。

4. 项目安装方式

如前所述，您可以使用 Ruby 的 gem 包管理器来安装 Cri：

gem install cri

确保在安装之前系统中的 Ruby 版本符合 Cri 的要求。安装完成后，您可以使用 Ruby 解释器来运行 Cri 定义的命令行工具。