whiz

Whiz 项目介绍

项目概述

Whiz 是一个为命令行设计的智能助手工具，可以被看作是终端的副驾驶。它帮助用户通过命令行更高效地完成各种任务。无论是管理文件、执行网络请求，还是在浏览器中打开特定网站，Whiz 都能够提供便捷的支持。

安装指南

要在你的机器上安装 Whiz，可以使用以下命令通过 npm 全局安装：

npm install -g whiz_cli

安装后，需要设置 OPENAI_API_KEY 以便 Whiz 能够正常运行。你可以将这一环境变量添加到你的 .bashrc 或 .zshrc 文件中。在 Windows 系统中，你可以将其添加到系统的环境变量中。

如果你希望使用不同于 gpt-3.5-turbo 的模型，可以通过设置 WHIZ_LLM_MODEL 指定模型的名称。可用模型的列表可以在 OpenAI 的 模型文档 中找到。例如，你可以这样设置来使用 gpt-4 模型：

export OPENAI_API_KEY=<your key>
export WHIZ_LLM_MODEL=gpt-4

项目功能

Whiz 提供了一种简单的命令行使用方式，只需输入 wz 后跟上你的请求即可。例如：

wz curl google and store response in google.html
wz open google.com in chrome
wz list recent github branches sorted by activity

这些命令可以帮助你快速执行一些常见的任务，如网络请求、浏览网页以及管理 GitHub 分支等，让你在终端中更加高效。

隐私声明

Whiz 在使用过程中会向 OpenAI 发送如下信息：

• 你的操作系统平台（例如：'android', 'darwin', 'linux', 'openbsd' 或 'win32'）
• 你的 CPU 架构（例如：'x32', 'x64', 'arm' 或 'arm64'）
• 你的终端路径（即 process.env.SHELL）
• 你的请求内容，但请不要发送任何敏感信息

请注意，Whiz 不会发送其他环境信息，比如文件名或文件内容。

贡献指南

我们欢迎社区的贡献！有关贡献的详细信息，请阅读 CONTRIBUTING.md 文档。

许可证

Whiz 项目采用 MIT 许可协议，详细信息可以查看 LICENSE 文件。

通过这份许可证，用户享有相对宽松的使用权利，同时也需要遵循相关的法律条款。