Hey! - Your AI-powered Pair Programming Friend

:basecamp: - Watch this YouTube <a href="https://www.youtube.com/watch?v=fhO34PVa-38&list=LL&index=9">introduction video</a> about Hey!

:writing_hand: - Read the <a href="https://blog.imsadra.dev/introducing-hey-your-ai-powered-pair-programming-friend">"Introducing Hey! - Your AI-powered Pair Programming Friend"</a> article about the creation process, development phases, and a detailed overview of Hey.

Hey is a free CLI-based AI assistant that is powered by the LLMs. You can set which LLM service you want to connect Hey to.

[!TIP] We recommend using the free tokens provided by MindsDB. You can generate one for your personal uses for free on mdb.ai. You can set Hey to interact with any other LLM service though. You're not limited to mdb.ai. It's a recommendation.

Installation

Make sure you have pip and python>=3.8 installed on your machine and follow the steps.

1. Setup the package

Option A - Download from PyPI

pip install -U hey-mindsdb

Option B - Download from the repository

pip install git+http://github.com/lnxpy/hey.git

2. Set the token

Once you got the package installed on your system, it's time to set the token into hey. Run the following command to set the token.

hey auth

</details>

Usage

There are different commands and sub-commands implemented once you install hey. Check them out via the --help flag.

hey --help

TLDR;

If you want to use Hey in a fast and quick way, use the ask command.
```
hey ask "explain the duality term in quantum physics."
```
If your question needs more explanations with code snippets maybe, then just hey.
```
hey
<OPENS EDITOR>
```
Keep in mind that when you run hey with no sub-commands, the default $EDITOR will be used. If this environment variable is not set, then vim on Unix-like systems and notepad on Windows machines will be used by default.

Configuration

There is a command dedicated for more customizability. Check the following bullet-points.

Create a base configuration file.
```
hey config create
```
View and edit the configuration file.
```
hey config edit
```

Here is more information about each configuration parameter.

{
    // llm service URL
    "service": "https://llm.mdb.ai",

    // model version
    "model": "gpt-3.5-turbo",

    // prompt
    "prompt": "Answer in a helpful way.",

    // themes used for the codeblocks
    "code_block_theme": "github-light",

    // how would you like `hey` to think?
    "loading_text": "Thinking..",

    // check out full list: python -m rich.spinner
    "loading_spinner": "dots",

    // never style the output (in case you need to copy the result)
    "never_style": false
}

License

Hey is being licensed under the MIT License.

Shout-out to

Hey! was created for a hackathon partnering MindsDB X Hashnode.

Hey

Install / Use

README