ExCLI 项目使用教程

ExCLI 项目使用教程

ex_cliUser friendly CLI apps for Elixir项目地址:https://gitcode.com/gh_mirrors/ex/ex_cli

项目介绍

ExCLI 是一个用于构建用户友好的命令行应用程序的 Elixir 库。它提供了一套 DSL（领域特定语言）来定义命令行接口，并支持生成 mix 任务或 escript 脚本。ExCLI 的目标是简化 Elixir 开发者创建 CLI 应用的过程，使其更加直观和高效。

项目快速启动

安装 ExCLI

首先，将 ExCLI 添加到你的项目的依赖列表中。在你的 mix.exs 文件中添加以下内容：

def deps do
  [
    {:ex_cli, "~> 0.1.0"}
  ]
end

然后运行 mix deps.get 来安装依赖。

创建一个简单的 CLI 应用

以下是一个简单的 CLI 应用示例：

defmodule MyApp.SampleCLI do
  use ExCLI.DSL

  name "mycli"
  description "My CLI"
  long_description ~S"""
  This is my long description for the CLI application.
  """

  command :hello do
    description "Say hello"

    argument :name, required: true, description: "Your name"

    action do
      IO.puts "Hello, #{name}!"
    end
  end
end

运行 CLI 应用

你可以通过以下方式运行你的 CLI 应用：

ExCLI.run(MyApp.SampleCLI, args)

其中 args 是命令行参数列表。

应用案例和最佳实践

生成 Escript

你可以通过设置 escript: true 来生成一个 escript 脚本：

defmodule MyEscriptCLI do
  use ExCLI.DSL, escript: true

  # 定义你的命令
end

在你的 mix.exs 文件中配置 escript：

def project do
  [
    app: :my_app,
    escript: [main_module: MyEscriptCLI]
  ]
end

生成 Mix 任务

你可以通过设置 mix_task: TASK_NAME 来生成一个 mix 任务：

defmodule MyCLITask do
  use ExCLI.DSL, mix_task: :great_task

  # 定义你的命令
end

然后你可以通过 mix great_task 来运行这个任务，并通过 mix help great_task 获取帮助信息。

典型生态项目

ExCLI 可以与其他 Elixir 项目和工具集成，例如：

• Phoenix Framework: 用于构建 Web 应用的框架，可以与 ExCLI 结合使用来创建管理任务。
• Ecto: 用于数据库操作的库，可以通过 ExCLI 创建数据库迁移和种子任务。
• ExUnit: Elixir 的单元测试框架，可以通过 ExCLI 创建测试任务。

通过这些集成，你可以更高效地管理和扩展你的 Elixir 项目。

ex_cliUser friendly CLI apps for Elixir项目地址:https://gitcode.com/gh_mirrors/ex/ex_cli