# groqchat
A terminal chatbot, powered by Groq Cloud API (Windows / macOS / Linux / Android / iOS)
Modified groq chatbot developed in https://github.com/eliranwong/freegenius
A simple chatbot that runs fast on mobile phones as well as pc.
# Groq API Key
Get a Groq API key first. Read https://github.com/eliranwong/freegenius/wiki/Set-up-a-Groq-Cloud-API-Key
# Android / iOS / iPhone / iPad Users
iOS/iPad/iPhone: Use [iSH](https://ish.app/) on iOS/iPad/iPhone.
Android: Use [Termux](https://termux.dev/en/) on Android.
# Installation
With python installed, setup gropchat via pip:
> pip install groqchat
Or
> pip install gchat
# Android Users
1. Install rust
> pkg install rust
2. Use "--system-site-packages" if you create a virtual environment, e.g.
> python -m venv gchat --system-site-packages
> source gchat/bin/activate
> pip install --upgrade gchat
On Android, use Android built-in voice typing keyboards of Ctrl+S.
Install [Termux:API](https://wiki.termux.com/wiki/Termux:API), to work with response output on Andoird.
# Get Started
Simply run 'gchat':
> gchat
Enter your Groq cloud a single API key or a list of multiple API keys:<br>
(Remarks: If a list of multiple API keys are entered, entered API keys are automatically rotated for running inference.)
<img width="1004" alt="groqapi" src="https://github.com/eliranwong/groqchat/assets/25262722/a510f465-1768-4fcb-8ae5-cfab9f3adad8">
Select a model:
<img width="1004" alt="models" src="https://github.com/eliranwong/groqchat/assets/25262722/42cbcd85-b13a-4188-98e6-2abf99542993">
# Special Entries
Enter a dot '.' to display available special entries:
<img width="1004" alt="ui" src="https://github.com/eliranwong/groqchat/assets/25262722/31fa20e7-24cb-4aa1-b67e-38f6bf24971d">
'.new' - start a new chart session
'.api' - change api key
'.model' - change model
'.systemmessage' - change system message
'.temperature' - change temperature
'.maxtokens' - change max tokens
'.togglewordwrap' - toggle word wrap
'.togglevoiceoutput' - toggle voice output
'.exit' - exit the application
# Keyboard Shortcuts
By default:
Ctrl+Z - cancel
Ctrl+Q - exit / quit
Ctrl+I / TAB - insert new line
Ctrl+N - new chat session
Ctrl+W - toggle word wrap
Ctrl+Y - toggle voice output
Ctrl+S - trigger voice typing
# Configurations
Advanced users may change configurations manually by editing the file "config.py" located in the package folder.
Remarks: Close the app before editing the file.
# CLI Options
Run 'gchat --help' for cli options
> gchat --help
<img width="1004" alt="cli_option" src="https://github.com/eliranwong/groqchat/assets/25262722/eb58aeaf-7cc7-4170-b253-1200b99d57e9">
For example, to start with a greeting:
> gchat "Hi!"
For example, to set temperature to 0.8 and maximum output tokens to 1024, run:
> gchat -t 0.8 -o 1024 "Hi!"
# Install Multiple Copies
You may want to install multiple copies to customise them with different system messages or other settings.
An easy way to achieve it is to use alias, e.g.:
> mkdir apps
> cd apps
> python3 -m venv assist explain quote illustrate summarize
> source assist/bin/activate
> pip install gchat
> source explain/bin/activate
> pip install gchat
> source quote/bin/activate
> pip install gchat
> source illustrate/bin/activate
> pip install gchat
> source summarize/bin/activate
> pip install gchat
> nano .bashrc
Add the following aliases:
```
alias explain=$HOME/apps/explain/bin/gchat
alias illustrate=$HOME/apps/illustrate/bin/gchat
alias quote=$HOME/apps/quote/bin/gchat
alias assist=$HOME/apps/assist/bin/gchat
alias summarize=$HOME/apps/summarize/bin/gchat
```
Raw data
{
"_id": null,
"home_page": "https://letmedoit.ai",
"name": "groqchat",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ai google gemini palm codey vertex api multimodal vision",
"author": "Eliran Wong",
"author_email": "support@letmedoit.ai",
"download_url": "https://files.pythonhosted.org/packages/16/94/6d52c75ff3f94f91419f0747ae0e322469f2dc5613481a8962605fa9de81/groqchat-0.0.16.tar.gz",
"platform": null,
"description": "# groqchat\n\nA terminal chatbot, powered by Groq Cloud API (Windows / macOS / Linux / Android / iOS)\n\nModified groq chatbot developed in https://github.com/eliranwong/freegenius\n\nA simple chatbot that runs fast on mobile phones as well as pc.\n\n# Groq API Key\n\nGet a Groq API key first. Read https://github.com/eliranwong/freegenius/wiki/Set-up-a-Groq-Cloud-API-Key\n\n# Android / iOS / iPhone / iPad Users\n\niOS/iPad/iPhone: Use [iSH](https://ish.app/) on iOS/iPad/iPhone.\n\nAndroid: Use [Termux](https://termux.dev/en/) on Android.\n\n# Installation\n\nWith python installed, setup gropchat via pip:\n\n> pip install groqchat\n\nOr\n\n> pip install gchat\n\n# Android Users\n\n1. Install rust\n\n> pkg install rust\n\n2. Use \"--system-site-packages\" if you create a virtual environment, e.g.\n\n> python -m venv gchat --system-site-packages\n\n> source gchat/bin/activate\n\n> pip install --upgrade gchat\n\nOn Android, use Android built-in voice typing keyboards of Ctrl+S.\n\nInstall [Termux:API](https://wiki.termux.com/wiki/Termux:API), to work with response output on Andoird.\n\n# Get Started\n\nSimply run 'gchat':\n\n> gchat\n\nEnter your Groq cloud a single API key or a list of multiple API keys:<br>\n(Remarks: If a list of multiple API keys are entered, entered API keys are automatically rotated for running inference.)\n\n<img width=\"1004\" alt=\"groqapi\" src=\"https://github.com/eliranwong/groqchat/assets/25262722/a510f465-1768-4fcb-8ae5-cfab9f3adad8\">\n\nSelect a model:\n\n<img width=\"1004\" alt=\"models\" src=\"https://github.com/eliranwong/groqchat/assets/25262722/42cbcd85-b13a-4188-98e6-2abf99542993\">\n\n# Special Entries\n\nEnter a dot '.' to display available special entries:\n\n<img width=\"1004\" alt=\"ui\" src=\"https://github.com/eliranwong/groqchat/assets/25262722/31fa20e7-24cb-4aa1-b67e-38f6bf24971d\">\n\n'.new' - start a new chart session\n\n'.api' - change api key\n\n'.model' - change model\n\n'.systemmessage' - change system message\n\n'.temperature' - change temperature\n\n'.maxtokens' - change max tokens\n\n'.togglewordwrap' - toggle word wrap\n\n'.togglevoiceoutput' - toggle voice output\n\n'.exit' - exit the application\n\n# Keyboard Shortcuts\n\nBy default:\n\nCtrl+Z - cancel\n\nCtrl+Q - exit / quit\n\nCtrl+I / TAB - insert new line\n\nCtrl+N - new chat session\n\nCtrl+W - toggle word wrap\n\nCtrl+Y - toggle voice output\n\nCtrl+S - trigger voice typing\n\n# Configurations\n\nAdvanced users may change configurations manually by editing the file \"config.py\" located in the package folder.\n\nRemarks: Close the app before editing the file.\n\n# CLI Options\n\nRun 'gchat --help' for cli options\n\n> gchat --help\n\n<img width=\"1004\" alt=\"cli_option\" src=\"https://github.com/eliranwong/groqchat/assets/25262722/eb58aeaf-7cc7-4170-b253-1200b99d57e9\">\n\nFor example, to start with a greeting:\n\n> gchat \"Hi!\"\n\nFor example, to set temperature to 0.8 and maximum output tokens to 1024, run:\n\n> gchat -t 0.8 -o 1024 \"Hi!\"\n\n# Install Multiple Copies\n\nYou may want to install multiple copies to customise them with different system messages or other settings. \n\nAn easy way to achieve it is to use alias, e.g.:\n\n> mkdir apps\n\n> cd apps\n\n> python3 -m venv assist explain quote illustrate summarize\n\n> source assist/bin/activate\n\n> pip install gchat\n\n> source explain/bin/activate\n\n> pip install gchat\n\n> source quote/bin/activate\n\n> pip install gchat\n\n> source illustrate/bin/activate\n\n> pip install gchat\n\n> source summarize/bin/activate\n\n> pip install gchat\n\n> nano .bashrc\n\nAdd the following aliases:\n\n```\nalias explain=$HOME/apps/explain/bin/gchat\nalias illustrate=$HOME/apps/illustrate/bin/gchat\nalias quote=$HOME/apps/quote/bin/gchat\nalias assist=$HOME/apps/assist/bin/gchat\nalias summarize=$HOME/apps/summarize/bin/gchat\n```\n\n\n",
"bugtrack_url": null,
"license": "GNU General Public License (GPL)",
"summary": "A terminal chatbot, powered by Groq Cloud API (Windows / macOS / Linux / Android / iOS)",
"version": "0.0.16",
"project_urls": {
"Documentation": "https://github.com/eliranwong/groqchat/wiki",
"Funding": "https://www.paypal.me/letmedoitai",
"Homepage": "https://letmedoit.ai",
"Source": "https://github.com/eliranwong/groqchat",
"Tracker": "https://github.com/eliranwong/groqchat/issues"
},
"split_keywords": [
"ai",
"google",
"gemini",
"palm",
"codey",
"vertex",
"api",
"multimodal",
"vision"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb2cf7ea6505e677fc9da5626c681a5b0a3c887528f9cdd711c5c7d763c61308",
"md5": "c8391f3c7ed4436d7109e5231366fe6d",
"sha256": "6a740d6d1a7305ac4447150b266f5f353d8f977b7e4c083760e5e73ae16441fa"
},
"downloads": -1,
"filename": "groqchat-0.0.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c8391f3c7ed4436d7109e5231366fe6d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 25308,
"upload_time": "2024-07-05T16:19:53",
"upload_time_iso_8601": "2024-07-05T16:19:53.316187Z",
"url": "https://files.pythonhosted.org/packages/cb/2c/f7ea6505e677fc9da5626c681a5b0a3c887528f9cdd711c5c7d763c61308/groqchat-0.0.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "16946d52c75ff3f94f91419f0747ae0e322469f2dc5613481a8962605fa9de81",
"md5": "2edfbcdbc85eafd4e4d95a578cb3dd57",
"sha256": "cd94ee9b40088d42b841c3732001aee325e401c0d56f5101781f1ae4344c7273"
},
"downloads": -1,
"filename": "groqchat-0.0.16.tar.gz",
"has_sig": false,
"md5_digest": "2edfbcdbc85eafd4e4d95a578cb3dd57",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 23744,
"upload_time": "2024-07-05T16:19:54",
"upload_time_iso_8601": "2024-07-05T16:19:54.841900Z",
"url": "https://files.pythonhosted.org/packages/16/94/6d52c75ff3f94f91419f0747ae0e322469f2dc5613481a8962605fa9de81/groqchat-0.0.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-05 16:19:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "eliranwong",
"github_project": "groqchat",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "groqchat"
}
JSON
