/whiz

A copilot for your terminal

Primary LanguageTypeScriptMIT LicenseMIT

Whiz

A copilot for your terminal.

whiz

Installation

npm install -g whiz_cli

Now, you will need to set OPENAI_API_KEY in your environment. You can do this by adding the following to your .bashrc or .zshrc. On windows, you can set this in the environment variables.

If you want to use a different model than gpt-3.5-turbo, then set WHIZ_LLM_MODEL to the model name. You can find a list of models here. As an example, you can set WHIZ_LLM_MODEL=gpt-4 to use the gpt-4 model.

export OPENAI_API_KEY=<your key>

🚀 Usage

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

Privacy

Whiz sends the following information to OpenAI:

  • Your OS platform (process.platform): 'android', 'darwin', 'linux', 'openbsd', or 'win32'.
  • Your CPU architecture (process.arch): 'x32', 'x64', 'arm', or 'arm64'.
  • Your shell path (process.env.SHELL).
  • Your request, so don't send any sensitive information.

No other environment information, such as filenames or file content, is sent to OpenAI.

🤗 Contributing

Please read CONTRIBUTING.md for details.

🔖 License

This project is licensed under the MIT License - see the LICENSE file for details