Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lnxpy/hey
💬 AI-Powered Pair Programming Friend!
https://github.com/lnxpy/hey
ai chatbot chatgpt hackathon hashnode hey mindsdb package pypi python python-package
Last synced: 9 days ago
JSON representation
💬 AI-Powered Pair Programming Friend!
- Host: GitHub
- URL: https://github.com/lnxpy/hey
- Owner: lnxpy
- License: mit
- Created: 2023-04-18T07:32:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-17T13:59:57.000Z (22 days ago)
- Last Synced: 2024-10-19T19:50:35.754Z (20 days ago)
- Topics: ai, chatbot, chatgpt, hackathon, hashnode, hey, mindsdb, package, pypi, python, python-package
- Language: Python
- Homepage: https://pypi.org/project/hey-mindsdb/
- Size: 127 KB
- Stars: 232
- Watchers: 1
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ChatGPT-repositories - hey - 💬 AI-Powered Pair Programming Friend! (Chatbots)
README
## Hey! - Your AI-powered Pair Programming Friend 
> :basecamp: - Watch this YouTube introduction video about Hey!
> :writing_hand: - Read the "Introducing Hey! - Your AI-powered Pair Programming Friend" 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](https://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
```sh
pip install -U hey-mindsdb
```
###### Option B - Download from the repository
```sh
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.
```sh
hey auth
```
### Usage
There are different commands and sub-commands implemented once you install `hey`. Check them out via the `--help` flag.
```sh
hey --help
```
#### TLDR;
- If you want to use `Hey` in a fast and quick way, use the `ask` command.
```sh
hey ask "explain the duality term in quantum physics."
```
- If your question needs more explanations with code snippets maybe, then just `hey`.
```sh
hey
```
> 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.
```sh
hey config create
```
- View and edit the configuration file.
```sh
hey config edit
```
Here is more information about each configuration parameter.
```json
{
// 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](https://github.com/lnxpy/hey/blob/main/LICENSE).
### Shout-out to
Hey! was created for a hackathon partnering [MindsDB](https://mindsdb.com) X [Hashnode](https://hashnode.com).
