/cha

A simple CLI chat tool to easily interface with OpenAI's models

Primary LanguagePythonMIT LicenseMIT

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!

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 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

Demo Video

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:

pip3 install --upgrade .

2. Configure API Key

  1. Create a .env file in the root directory.

  2. Obtain your OpenAI API key HERE. If you want to use Answer-Search, obtain your Brave API key HERE. 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.

  3. Add your keys to the .env file, using this format:

    # 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:

source .env

3. Run cha

To start the tool, execute:

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:

# zsh
cat cha.sh >> $HOME/.zshrc

# bash
cat cha.sh >> $HOME/.bashrc

Then, run my configuration of cha:

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:

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