GLI 项目技术文档

1. 安装指南

1.1 使用 RubyGems 安装

要安装 GLI，您可以使用 RubyGems 命令行工具。打开终端并运行以下命令：

gem install gli

安装完成后，您可以通过运行以下命令来验证安装是否成功：

gli help

如果安装成功，您将看到格式化的帮助输出。

1.2 使用 Bundler 安装

如果您在另一个 Ruby 应用程序中使用 GLI，可以将它添加到您的 Gemfile 中：

gem "gli"

然后运行以下命令来安装依赖项：

bundle install

您可以通过运行以下命令来测试安装：

bundle exec gli help

这将输出 GLI 的帮助信息。

2. 项目的使用说明

2.1 初始化项目

要开始使用 GLI，您可以创建一个脚手架项目。运行以下命令：

gli init todo list add complete

如果您是通过 Bundler 安装的，请使用以下命令：

bundle exec gli init todo list add complete

这将创建一个基本的脚手架项目在 ./todo 目录中，包含以下内容：

• 可执行文件 ./todo/bin/todo，该文件展示了描述命令行接口所需的大部分内容。
• 一个空的测试文件 ./todo/test/default_test.rb，可以引导您的测试。
• 一个 gemspec 文件。
• 一个 README 文件。
• 一个 Rakefile，可以生成 RDoc、打包 Gem 并运行测试。
• 一个适合与 Bundler 一起使用的 Gemfile，用于管理开发时依赖项。

2.2 运行项目

进入项目目录并运行以下命令：

cd todo
bundle exec bin/todo help

您将看到类似以下的输出：

NAME
    todo - Describe your application here

SYNOPSIS
    todo [global options] command [command options] [arguments...]

VERSION
    0.0.1

GLOBAL OPTIONS
    -f, --flagname=The name of the argument - Describe some flag here (default: the default)
    --help                                  - Show this message
    -s, --[no-]switch                       - Describe some switch here

COMMANDS
    add      - Describe add here
    complete - Describe complete here
    help     - Shows a list of commands or help for one command
    list     - Describe list here

您可以通过运行以下命令来查看特定命令的帮助信息：

bundle exec bin/todo help list

这将输出 list 命令的帮助信息。

3. 项目API使用文档

3.1 GLI::DSL

GLI::DSL 提供了用于定义命令行应用程序的 DSL（领域特定语言）。您可以使用它来定义全局选项、命令和子命令。

3.2 GLI::App

GLI::App 是 GLI 的核心类，负责处理命令行解析和执行。您可以通过它来注册命令、处理选项和参数。

3.3 示例

以下是一个简单的示例，展示了如何使用 GLI 定义一个命令行应用程序：

require 'gli'

include GLI::App

program_desc 'A simple command-line app'

desc 'Add a new item'
command :add do |c|
  c.flag [:n, :name], :required => true
  c.action do |global_options, options, args|
    puts "Adding item: #{options[:name]}"
  end
end

exit run(ARGV)

4. 项目安装方式

4.1 通过 RubyGems 安装

gem install gli

4.2 通过 Bundler 安装

将以下内容添加到您的 Gemfile：

gem "gli"

然后运行：

bundle install

通过以上步骤，您可以成功安装并使用 GLI 来创建复杂的命令行应用程序。