Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/searchableguy/whiz
A copilot for your terminal
https://github.com/searchableguy/whiz
agent chat-gpt chatgpt cli copilot enquirer language-model llm node openai transformer typescript whiz
Last synced: 4 days ago
JSON representation
A copilot for your terminal
- Host: GitHub
- URL: https://github.com/searchableguy/whiz
- Owner: searchableguy
- License: mit
- Created: 2023-09-18T22:30:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-06T12:53:20.000Z (over 1 year ago)
- Last Synced: 2025-01-20T23:56:19.404Z (4 days ago)
- Topics: agent, chat-gpt, chatgpt, cli, copilot, enquirer, language-model, llm, node, openai, transformer, typescript, whiz
- Language: TypeScript
- Homepage:
- Size: 773 KB
- Stars: 285
- Watchers: 2
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Whiz
A copilot for your terminal.
## Installation
```bash
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](https://platform.openai.com/docs/models). As an example, you can set `WHIZ_LLM_MODEL=gpt-4` to use the `gpt-4` model.
```bash
export OPENAI_API_KEY=
```
## 🚀 Usage
```bash
# wz
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](CONTRIBUTING.md) for details.
## 🔖 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details