Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MehmetMHY/cha
A simple CLI chat tool to easily interface with OpenAI's models
https://github.com/MehmetMHY/cha
Last synced: about 2 months ago
JSON representation
A simple CLI chat tool to easily interface with OpenAI's models
- Host: GitHub
- URL: https://github.com/MehmetMHY/cha
- Owner: MehmetMHY
- License: mit
- Created: 2024-01-27T02:07:28.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-07-25T14:27:14.000Z (about 2 months ago)
- Last Synced: 2024-07-25T16:37:50.598Z (about 2 months ago)
- Language: Python
- Homepage:
- Size: 391 KB
- Stars: 36
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cli-apps - cha - A simple CLI chat tool to easily interface with OpenAI's models. (<a name="ai"></a>AI / ChatGPT)
- cli-apps - cha - A simple CLI chat tool to easily interface with OpenAI's models. (<a name="ai"></a>AI / ChatGPT)
README
## About
A simple CLI chat tool designed for easy interaction with OpenAI's models.
## Alternatives
If you want to use Anthropic's models in the CLI, check out [Cla](https://github.com/MehmetMHY/cla)!
## Features
- Basic CLI chat interface with OpenAI’s LLM models.
- Web scraping capability for provided links (supports JavaScript scraping).
- YouTube scraping functionality for extracting video transcripts.
- The YouTube scraper either scrapes transcripts or downloads the video's audio and converts it to text using OpenAI's Whisper model though the Groq API.
- Answer-Search feature utilizing the Brave API, similar to the Perplexity AI search engine.
- Click [HERE](https://www.youtube.com/watch?v=pTHk5G6TzH4) to view a demo of the Answer-Search feature.
- Multi-line support for easy copying and pasting into the CLI.
- Ability to generate images using OpenAI's image models.
- Uses CLImage to display images directly in the terminal.
- Supports both interactive and non-interactive chat modes.
- Stats option that estimates how much you have spent per session.
## Demo
[](https://www.youtube.com/watch?v=zRnMu6OHNtU)
*Click the image or visit https://www.youtube.com/watch?v=zRnMu6OHNtU*
## How To Set Up?
### 1. Install `cha`
Clone this repository, navigate to its directory, and run the following command to install or upgrade `cha`:
```bash
pip3 install --upgrade .
```
### 2. Configure API Key
1. Create a `.env` file in the root directory.
2. Obtain your OpenAI API key [HERE](https://platform.openai.com/api-keys). If you want to use Answer-Search, obtain your Brave API key [HERE](https://brave.com/search/api/). Also, if you want to use the YouTube scrapper more advance and accurate audio-mode, you will need a Groq API key which you can get [HERE](https://console.groq.com/keys).
3. Add your keys to the `.env` file, using this format:
```env
# Replace YOUR_KEY_HERE with your OpenAI API key
export OPENAI_API_KEY="YOUR_KEY_HERE"
# (Optional) Replace YOUR_KEY_HERE with your Brave API key
export BRAVE_API_KEY="YOUR_KEY_HERE"
# (Optional) Replace YOUR_KEY_HERE with your Groq API key
export GROQ_API_KEY="YOUR_KEY_HERE"
```
4. To activate the environment variables, run:
```bash
source .env
```
### 3. Run `cha`
To start the tool, execute:
```bash
cha
```
### 4. (Optional) Using my configuration of `cha`
If you would like, you can use my configuration of `cha`. To view my configuration, check out the `cha.sh` file. To use it, add the content from the `cha.sh` file to your shell's config file:
```bash
# zsh
cat cha.sh >> $HOME/.zshrc
# bash
cat cha.sh >> $HOME/.bashrc
```
Then, run my configuration of `cha`:
```bash
chatgpt
```
### 5. Now you're now ready to go!
## Develop Mode
For developing Cha, you can do the following:
### 1. Install `cha` in editable mode so that pip points to the source files of the cloned code:
```bash
pip install -e .
```
### 2. Make changes to the code, then run `cha` to try out your changes
### 3. If you add a new dependency, you will have to do step 1 again
## Other Notes
- To see and/or change hard-coded config variables/logic in Cha, checkout the `config.py` file.
## Credits
- [OpenAI Documentation](https://platform.openai.com/docs/introduction)
- [ChatGPT (GPT-4)](https://chat.openai.com/)
- [Ollama's CLI](https://ollama.com/)