A lightweight Zsh plugin that serves as a ChatGPT API frontend, enabling you to interact with ChatGPT directly from the Zsh
shell using only cURL
and jq
.
- Version 0.0.2-beta:
- Works with Azure Open AI Service
- Added error handling for AOI Rate limiting or parsing errors
- Improved Readme/Install instructions
See INSTALL.md. or
sh ./install.sh
Please ensure you have the following:
- An Azure Open AI service account with a deployed GPT-3.5 model.
- The OpenAI Key and OpenAI URL for your Azure Open AI service deployment.
If you haven't set up an Azure Open AI service account and deployed the GPT-3.5 model, follow these steps:
- Sign in to the Azure portal at https://portal.azure.com.
- Create a new Azure Open AI resource. Learn how to create an Azure Open AI resource with this Microsoft Learn guide.
- Follow the instructions to deploy the GPT-3.5 model within your Azure Open AI service. Refer to the Microsoft Learn guide for detailed steps on deploying the GPT-3.5 model.
Retrieve the OpenAI Key and OpenAI URL from your Azure Open AI service account.
Install zsh shell if you haven't already:
sudo apt-get install zsh
Set it as your default shell: (optional)
chsh -s $(which zsh)
You can also install oh-my-zsh if you want to.
Make sure you have cURL
and jq
installed.
If you would like to have markdown rendering with option -m
, glow
is required (Recommend).
ask '<your prompt>'
Use -c
for dialogue format communication (BETA)
ask -c
Use -m
for markdown rendering (glow required)
ask -m
Use -h
for more information.
ask -h
Use -d
to turn on debug mode.
ask -d