MedallionShell 使用指南

MedallionShell 使用指南

MedallionShellA .NET library simplifying the execution and chaining of processes项目地址:https://gitcode.com/gh_mirrors/me/MedallionShell

---

1. 项目介绍

MedallionShell 是一个专为 .NET 开发者设计的库，极大地简化了对外部进程的执行与链式调用过程。在 .NET 标准 1.3 及更高版本框架下兼容，包括 .NET Framework 4.5 及以上。它旨在解决 System.Diagnostics.Process 类使用中的繁琐和常见陷阱，通过提供简洁的 API 和对异步编程的支持，确保开发者能够高效且安全地操作进程。特性包括但不限于：异步/等待集成、标准I/O流的便捷管道传输、避免死锁与竞态条件、命令行参数的安全处理，以及丰富的进程控制选项。

---

2. 快速启动

开始使用 MedallionShell 非常简单，首先你需要通过 NuGet 包管理器安装该库：

dotnet add package MedallionShell --version 1.6.2

或者，在 Visual Studio 的包管理器控制台中执行上述命令。

之后，你可以通过下面的示例代码，体验如何简单地运行一个 Git 命令：

using Medallion.Shell;

// 运行并等待 git commit 命令完成
CommandResult result = Command.Run("git", "commit", "-m", "Initial commit").Wait();
if (result.ExitCode != 0)
{
    // 处理解析或执行错误
    Console.WriteLine($"Git commit failed with exit code {result.ExitCode}");
}
else
{
    Console.WriteLine("Commit successful.");
}

这段代码展示了如何执行一个命令并等待其完成，同时也检查了命令的退出码以判断成功与否。

---

3. 应用案例和最佳实践

示例：自动化Git标签创建

假设你需要在一个CI/CD流程中自动创建Git标签，MedallionShell 可让你轻松实现这一点：

string newTag = "v1.2.3";
var tagResult = Command.Run("git", "tag", newTag).Wait();

if (tagResult.Success)
{
    Console.WriteLine($"Tag '{newTag}' created successfully.");
}
else
{
    Console.Error.WriteLine($"Failed to create tag '{newTag}': {tagResult.StandardError}");
}

最佳实践：

• 异步编程：利用 await 关键字进行异步调用，以提高应用程序响应性。
• 错误处理：总是检查 CommandResult.ExitCode 并处理可能的错误输出。
• 安全传参：确保所有外部命令参数都正确转义，防止注入攻击。

---

4. 典型生态项目

虽然 MedallionShell 本身不直接构建于特定的生态系统之上，但它的通用性使其成为多个场景下的理想选择，比如与.NET Core CLI工具链结合执行构建、发布任务，或是集成至持续集成/持续部署(CI/CD)流程中，自动化软件发布过程。此外，对于任何需要与操作系统命令行交互的 .NET 应用程序，无论是Web开发、桌面应用还是云服务，MedallionShell 都能提供强大而灵活的支持。

---

通过遵循这份指南，您可以迅速上手 MedallionShell，将其高效地融入您的 .NET 项目中，简化命令行交互过程，提高代码质量和稳定性。

MedallionShellA .NET library simplifying the execution and chaining of processes项目地址:https://gitcode.com/gh_mirrors/me/MedallionShell