Ruke

一个极其简单的自动化工具。受 Makefile 和 Justfile 启发。

[!TIP] 查找 Dockerfile/docker-compose.yml 生成器？ gorvus 正在等待您！

🔑 关键特性

• 精美的界面：良好的体验、清晰的说明和彩色文本。
• 闪电般速度：用 Rust 编写，运行时感觉像火箭。
• 易于配置：与其他命令行运行器不同，Ruke 使用 TOML，因此您不需要学习新的语言。

🛠 使用方法

先决条件：Rust 和 Cargo。

安装

cargo install ruke

入门指南

首先，您需要在 Ruke.toml 文件中定义您的任务。

希望 Ruke 能帮到您，只需运行

ruke init

当您的 Ruke.toml 准备就绪后，现在您需要运行一个特定的任务。

运行任务的语法是 ruke [目标] 其中目标是要执行的任务。尝试这个

ruke

注意：目标任务 "main" 是默认的，因此如果您运行 ruke，则与运行 ruke main 相同。

掌握 CLI

可用命令

• ruke init - 在其中创建任务的 Ruke.toml 文件
• ruke list - 列出现有任务
• ruke new - 创建新任务（交互式模式）
• ruke add - 向现有任务添加命令（交互式模式）
• ruke remove - 删除现有任务（交互式模式）
• ruke [目标] - 运行特定任务

别名

• ruke init，ruke i
• ruke list，ruke ls
• ruke new，ruke n
• ruke add，ruke a
• ruke remove，ruke rm

参数和标志

如果您运行ruke --help，您将看到有用的指南，并且如果您需要特定命令的帮助，请尝试ruke help [command]。

示例

ruke list --minimal将输出比ruke list更少的信息（仅任务名称）。

ruke new -n "task-name"将创建一个名为"task-name"的新任务。

ruke add -n "task-name" -c "echo command-to-be-executed"将向名为"task-name"的任务中添加指定的命令。

ruke remove -n "task-name" -f path/to/Ruke.toml将意外目录中的Ruke.toml文件中的"task-name"任务删除。

ruke build将运行"build"任务并显示输出，而ruke build -q将静默运行。

掌握Ruke文件

我建议您使用以下两个名称之一：Ruke.toml或Rukefile，但是，只要您编写有效的TOML，就可以将文件命名为任何您想要的名字，并通过-f --file <FILE>标志传递。

查看TOML v1.0.0的完整规范。

[tasks.main]                       # defines a task with an unique name
commands = ["go run cmd/main.go"]  # defines a command array to be executed sequentially

[tasks.dev]
commands = ["pnpm dev"]

[tasks.build]
commands = ["go build -o gorvus cmd/main.go", "./gorvus"]

💖 贡献

请随时贡献，创建一个问题来报告错误、建议API更改、改进或功能。

如何贡献

1. Fork这个仓库
2. 在您的机器上克隆您的分支
3. 进行您的更改，提交并推送这些更改
4. 打开一个pull请求（写一个描述性消息说明您做了哪些更改）

贡献者

感谢这些杰出的人

📝 许可协议

本项目采用MIT许可协议 - 请参阅LICENSE以获取更多信息。

由Kauê Fraga Rodrigues用❤️和🦀制作。