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: about 2 months 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-06-11T23:32:29.000Z (3 months ago)
- Last Synced: 2024-07-30T13:19:47.337Z (about 2 months ago)
- Topics: ai, chatbot, chatgpt, hackathon, hashnode, hey, mindsdb, package, pypi, python, python-package
- Language: Python
- Homepage: https://pypi.org/project/hey-mindsdb/
- Size: 122 KB
- Stars: 108
- Watchers: 1
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Hey! - Your AI-powered Pair Programming Friend
> :sparkles: - You need a MindsDB token to use Hey. You can generate one for your personal uses for free from [here](mdb.ai)!
> :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 CLI-based AI assistant that is powered by the ChatGPT AI model versions supported by [MindsDB](https://mindsdb.com/). This project is designed for [Hashnode X MindsDB](https://hashnode.com/hackathons/mindsdb?source=hncounter-feed) hackathon.
### Installation
Make sure you have `pip` and `python>=3.6` installed on your machine and follow the steps.
1. Setup the package
##### Option A - Download from PyPI archive
```sh
pip install -U hey-mindsdb
```
##### Option B - Download from GitHub archive
```sh
pip install git+http://github.com/lnxpy/hey.git
```
> :warning:: Hey is POSIX-friendly. It might not work properly on Windows machines at the moment.
2. Set the HEY_TOKEN environment variable
Once you got the package installed on your system, it's time to add the token that you just copied from [mdb.ai](https://mdb.ai) into either the `.bashrc` (or `.zshrc`) file.
- If you use the default bash shell
```sh
echo "export HEY_TOKEN=" >> ~/.bashrc
```
- If you use ZSH
```sh
echo "export HEY_TOKEN=" >> ~/.zshrc
```
### Usage
There are different commands and sub-commands implemented once you install `hey`. Check them out via the `--help` flag.
```sh
hey --help
```
```
Usage: hey [OPTIONS] COMMAND [ARGS]...
Hey is a pair-programming friend that interacts with ChatGPT and responds back in a pretty
style. ✨
â•â”€ Options ─────────────────────────────────────────────────────────────────────────────────────╮
│ --no-style,--ns Don't style the output. │
│ --version -V Show the current version of Hey. │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or │
│ customize the installation. │
│ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────────────────────────────────────╯
â•â”€ Commands ────────────────────────────────────────────────────────────────────────────────────╮
│ ask Ask Hey directly in-command. │
│ config Configuration management. │
╰───────────────────────────────────────────────────────────────────────────────────────────────╯
```
- 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, 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
{
// 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..",
// thinking animation symbol
// 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
}
```
### Tech Stack
- Infrastructures & Hosting
- [MindsDB](https://mdb.ai)
### License
Hey is being licensed under the [MIT License](https://github.com/lnxpy/hey/blob/main/LICENSE).
### Special Thanks to
[MindsDB](https://mindsdb.com) X [Hashnode](https://hashnode.com) for hosting this great hackathon.
