Terminal-copilot

每次忘记终端命令的语法时，是否都不得不去 Google 搜索？别再烦恼了！Terminal-copilot 就是你的救星。

有了 Terminal-copilot，你可以直接在命令行中快速、轻松地获取常用终端命令。只需输入 copilot，后接你想要执行的自然语言指令，剩下的就交给 Terminal-copilot 吧。

例如，如果你想查找以 .txt 结尾的文件，只需输入： copilot 查找一个以 .txt 结尾的文件 Terminal-copilot 会为你展示所需的正确命令语法： find . -name "*.txt" 并且还提供执行、复制或解释该命令的选项。

你也可以使用 -q 选项，通过命令行向 GPT-4 提出一般性问题： copilot -q "深夜写代码最适合喝什么饮料？"

安装

要使用 Terminal-copilot，首先需要在你的系统上安装它。最简单的方式是使用 pip： pip install terminal-copilot 安装完成后，你可以在命令行中输入 copilot 加上你的问题来调用它。

使用示例

Terminal-copilot 的设计非常简单直观。只需输入 copilot 加上你的问题，它就会为你展示所需命令的正确语法。

以下是一些使用 Terminal-copilot 的示例：

1. copilot 列出 Gcloud 中的计算实例
2. copilot 查找我主目录中的所有 mp3 文件
3. copilot 安装 Python 的 openai 包
4. copilot 清理我的 Docker 镜像
5. copilot 列出带有标签 'awesome' 的正在运行的 k8s Pod

或者，你还可以使用 -q 选项，通过命令行向 GPT-4 提问： copilot -q 为什么 42 是生命的意义？ （注意：目前暂不支持带问号的查询……）

参数

Terminal-copilot 支持一些可选的命令行参数：

• -a, --alias：启用将别名包含在发送给 OpenAI API 的提示中。这可能会将敏感信息发送到 OpenAI。
• -v, --verbose：增加工具的输出详细程度。
• -g, --git：此标志会将 Git 上下文包含在发送给 OpenAI API 的提示中。对于使用 Git 仓库的用户来说很有用，可能包括当前分支名称、仓库状态、最近的提交信息以及文件历史记录。
• -hist, --history：启用将终端历史记录包含在发送给 OpenAI API 的提示中。这可能会将敏感信息发送到 OpenAI，并增加使用的 token 数量。
• -j, --json：以 JSON 格式输出数据，而不是使用交互式提示。
• -c, --count：当指定 JSON 输出时，控制输出命令的数量。
• -m, --model：使用的模型，默认为 gpt-3.5-turbo。
• -ns, --no-stream：禁用将命令流式传输到终端的功能（默认是启用的）。

系统要求

Python 3.7+ Mac OS、Windows 或 Linux

敏感信息

请注意，Terminal-copilot 有能力将敏感信息作为生成终端命令的提示的一部分发送给 OpenAI。这包括 --alias、--history 和 --git 这些命令行参数，它们可能会包含别名和终端历史等敏感信息。如果你担心敏感信息可能被发送到 OpenAI，建议不要使用这些标志。我们建议用户在使用这些可选功能时谨慎行事，并在启用之前考虑潜在风险。

开发

贡献

我们欢迎对 Terminal-copilot 的贡献！如果你有新功能的想法或发现了 bug，请提交一个问题。如果你想贡献代码，请提交一个拉取请求！

感谢你考虑为 Terminal-copilot 做出贡献！让我们一起努力，使它成为访问终端命令的更优秀工具。

本地安装

1. 克隆仓库
2. python -m venv .venv && source .venv/bin/activate && pip install -r requirements.txt
3. python setup.py install

打包发布到 PyPI

首先确保已安装 pip install wheel 和 pip install twine。然后按照以下步骤操作： 0. 修改 setup.py 中的版本号

1. rm -rf dist
2. python setup.py sdist bdist_wheel
3. twine upload dist/*

terminal-copilot 快速上手指南

环境准备

• 操作系统：macOS、Windows 或 Linux
• Python 版本：Python 3.7 及以上
• 前置依赖：需确保已安装 pip 包管理工具，并配置好 OpenAI API Key（工具运行时需要）

安装步骤

使用 pip 直接安装是最便捷的方式。国内用户建议使用清华或阿里云镜像源以加速下载：

# 使用默认源安装
pip install terminal-copilot

# 或使用国内镜像源加速安装（推荐）
pip install terminal-copilot -i https://pypi.tuna.tsinghua.edu.cn/simple

安装完成后，即可在终端中通过 copilot 命令调用该工具。

基本使用

在命令行中输入 copilot 后接自然语言描述的需求，工具将自动生成对应的终端命令，并提供执行、复制或解释选项。

示例 1：查找文件 查找当前目录下所有 .txt 结尾的文件：

copilot find a file ending in .txt

输出示例：find . -name "*.txt"

示例 2：管理云服务 列出 Google Cloud 中的计算实例：

copilot list the compute instances in gcloud

示例 3：清理环境 清理本地的 Docker 镜像：

copilot clean up my docker images

通用问答模式 使用 -q 参数可直接向 GPT-4 提问（注意：目前不支持在问题末尾加问号）：

copilot -q "What is the best drink for late night coding?"