- Watch this YouTube introduction video about Hey!
โ๏ธ - 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. This project is designed for Hashnode X MindsDB hackathon.
You may need a MindsDB token to use Hey. You can generate one for your personal uses for free from here. You can set Hey to interact with any other LLM service URL though. You're not limited to mdb.ai.
Make sure you have pip and python>=3.6 installed on your machine and follow the steps.
pip install -U hey-mindsdbpip install git+http://github.com/lnxpy/hey.git
โ ๏ธ : Hey is POSIX-friendly. It might not work properly on Windows machines at the moment.
Once you got the package installed on your system, it's time to add the token that you just copied from mdb.ai into either the .bashrc (or .zshrc) file.
- If you use the default bash shell
echo "export HEY_TOKEN=<TOKEN>" >> ~/.bashrc- If you use ZSH
echo "export HEY_TOKEN=<TOKEN>" >> ~/.zshrcThere are different commands and sub-commands implemented once you install hey. Check them out via the --help flag.
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
Heyin a fast and quick way, use theaskcommand.hey ask "explain the duality term in quantum physics." -
If your question needs more explanations with code snippets, then just
hey.hey <OPENS EDITOR>
Keep in mind that when you run
heywith no sub-commands, the default$EDITORwill be used. If this environment variable is not set, thenvimon Unix-like systems andnotepadon Windows machines will be used by default.
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..",
// 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
}- Infrastructures & Hosting
Hey is being licensed under the MIT License.
MindsDB X Hashnode for hosting this great hackathon.
