Envoy 项目技术文档

1. 安装指南

Envoy 是一个方便的 Python 库，用于简化 subprocess 模块的使用。要安装 Envoy，您可以使用 pip 进行安装。以下是安装步骤：

pip install envoy

2. 项目的使用说明

Envoy 提供了一个简单的方式来运行命令行命令，并获取其输出。以下是一些基本的使用示例：

运行命令并获取响应

import envoy

# 运行命令
r = envoy.run('git config', data='data to pipe in', timeout=2)

# 获取状态码
print(r.status_code)  # 输出: 129

# 获取标准输出
print(r.std_out)  # 输出: 'usage: git config [options]'

# 获取标准错误
print(r.std_err)  # 输出: ''

管道操作

import envoy

# 运行管道命令
r = envoy.run('uptime | pbcopy')

# 获取命令
print(r.command)  # 输出: 'pbcopy'

# 获取状态码
print(r.status_code)  # 输出: 0

# 获取历史记录
print(r.history)  # 输出: [<Response 'uptime'>]

3. 项目API使用文档

Envoy 提供了以下主要 API：

envoy.run(command, data=None, timeout=None)

• command: 要运行的命令字符串。
• data: 可选参数，用于向命令传递数据。
• timeout: 可选参数，设置命令的超时时间。

返回值: 返回一个 Response 对象，包含以下属性：

• status_code: 命令的退出状态码。
• std_out: 命令的标准输出。
• std_err: 命令的标准错误输出。
• history: 命令的历史记录。

4. 项目安装方式

Envoy 可以通过 pip 进行安装，安装命令如下：

pip install envoy

安装完成后，您可以在 Python 脚本中导入并使用 Envoy 库。

---

通过以上文档，您应该能够顺利安装和使用 Envoy 项目。如有任何问题，请参考项目源码或相关文档。