gptsh - 跨平台命令行工具，轻松将自然语言转换为Shell命令

gptsh 项目介绍

gptsh 是一个跨平台的命令行工具，是使用 NodeJS 构建并由 Open AI 的 GPT-3 提供支持的。这个工具的主要目的是将自然语言的问题和请求翻译成 shell 命令。gptsh 受到其他项目如 nlsh 和 cmdxyz 的启发，可以很容易地安装并与传统的 shell 环境结合使用。

功能与特点

gptsh 并不是传统 shell 命令的完全替代品。它的角色是帮助用户在常见任务中，快速生成不熟悉的命令。例如，当用户需要压缩或解压文件、使用新框架、搜索系统中文件等场景时，gptsh 可以提供帮助。

使用演示

项目中提供了一些使用示例，可以让用户直观感受这个工具的功能。如通过简单的自然语言输入，工具可以迅速返回对应的 shell 命令，帮助用户执行各种操作。

安装说明

用户可以通过 NPM 或 Yarn 将 gptsh 全局安装在自己的系统上：

npm install --global gptsh

yarn global add gptsh

用户也可以使用 Docker 运行 gptsh 镜像，方法如下：

docker run --rm -e OPENAI_SECRET_KEY shorwood/gptsh <input>

可以为方便快速使用，将该命令设为别名：

alias gptsh='docker run --rm -e OPENAI_SECRET_KEY shorwood/gptsh'
gptsh Reset Nginx
sudo service nginx restart

快速上手

要使用 gptsh，用户需要设置 OpenAI API 密钥，可以将其设为环境变量：

OPENAI_SECRET_KEY=<YOUR_SECRET_KEY>
OPENAI_ENGINE_ID=davinci

也可以在执行命令时通过选项设置：

gptsh <input> --secret <YOUR_SECRET_KEY>

或者在主目录的 ~/.gptshrc 配置文件中进行设置：

secret=sk-XckwVRipQyM9nr1M8jVGGBUvDGIqwVmsbcrznkwz
engine=davinci
platform=linux

使用方法

Usage: gptsh <input> [options]

Options:
      --version      显示版本号                                   [boolean]
  -s, --secret       认证所需的 OpenAI API 密钥                      [string]
  -e, --engine       使用的引擎 ID                                  [string]
  -t, --tokens       消耗的最大 token 数量         [number] [default: 100]
      --temperature  越高的值表示模型将更冒险
                                                 [number] [default: 0.0]
  -p, --platform     输出命令的平台                                [string]
  -n                 生成的完成项数量                              [number]
      --help         显示帮助信息                                  [boolean]

使用示例

以下是一些使用 gptsh 的示例：

$ gptsh install node 12 repository
curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -

$ gptsh add yarn bin folder to path on zsh
echo 'export PATH="$HOME/.yarn/bin:$PATH"' >> ~/.zshrc

$ gptsh List all files of this directory | bash
LICENSE  data  node_modules  package.json  src  yarn.lock

gptsh 也支持其他平台的命令：

PS C:\WINDOWS\system32> gptsh Add a new user --platform win32
Add-ADUser -Name "username" -SamAccountName username -AccountPassword (Read-Host -AsSecureString "Password") -Enabled $true -ChangePasswordAtLogon $false

贡献

项目欢迎开发者贡献代码。在进行重大更改前，请先提交 issue 以讨论想要的变更。

许可证

gptsh 采用 MIT 许可证。