C 库 cmd 使用与技术文档

本文档旨在帮助用户安装和使用 C# 库 cmd，该库提供了一种简便的方式运行外部程序或命令，并展示了 C# 的动态特性。以下是安装指南、项目使用说明以及项目 API 使用文档。

1. 安装指南

通过 Nuget 包管理器安装

您可以通过 Nuget 包管理器获取 cmd 库。

从源代码构建

或者，您可以从源代码构建 cmd 库。

2. 项目使用说明

创建动态实例

首先，创建一个 cmd 的动态实例：

dynamic cmd = new Cmd();

调用命令

现在，您可以调用 cmd 实例上的命令：

cmd.git.clone("http://github.com/manojlds/cmd");

上述代码相当于执行 git clone http://github.com/manojlds/cmd。

传递参数

您可以通过命名参数传递标志：

cmd.git.log(grep: "test");

上述代码相当于执行 git log --grep test。

或者：

cmd.git.branch(a: true);

这将相当于执行 git branch -a。

请注意，单字符标志映射为 -<flag>，多字符标志映射为 --<flag>。如果非字符串值会被忽略，如果没有标志，则不考虑该参数。

您可以在同一个 cmd 实例上调用多个命令：

var gitOutput = cmd.git();
var svnOutput = cmd.svn();

请注意，命令区分大小写，因此 cmd.git 不等同于 cmd.Git。

设置环境变量

您可以通过在 Cmd 实例上调用 ._Env 方法来为进程设置环境变量，并传递一个包含环境变量名和值的 Dictionary<string, string>：

cmd._Env(new Dictionary<string, string> { { "GIT_DIR", @"C:\" } });

请注意，这将替换现有的变量值。

选择外壳程序

您可以使用 cmd 运行命令（cmd 或 Powershell）。在创建 cmd 实例时选择您想要使用的壳程序：

dynamic cmd = new Cmd(Shell.Cmd);
dynamic posh = new Cmd(Shell.Powershell);
cmd.dir();

当使用 Shell.Cmd 时，标志使用 / 而不是 - 和 -- 构造。

Powershell 支持仍在开发中。

3. 项目 API 使用文档

动态调用

• cmd.command(name, params)：调用指定名称的命令，并传递参数。

设置环境变量

• cmd._Env(envVars)：为进程设置环境变量。

4. 项目安装方式

请参考上述“安装指南”中的步骤进行项目安装。

cmd 库正处于初期阶段，未来将提供更多类似 sh 的功能。希望本文档能够帮助您顺利使用 cmd 库。