Skip to main content

# 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

  1. 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 `

Metadata

Release files for groqchat 0.0.17

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for groqchat 0.0.17
File Size Uploaded
groqchat-0.0.17.tar.gz 23.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for groqchat 0.0.17
File Interpreter ABI Platform
groqchat-0.0.17-py3-none-any.whl Python 3 none any Details

Total release size: 49.0 kB

Release files / groqchat-0.0.17.tar.gz

Download URL groqchat-0.0.17.tar.gz
Size 23.7 kB
Tags Source
SHA-256 checksum
How to use checksums
f1517543e3be9f86f5127bbcd0fd90dae25e5fdd6b71893bf84cdf8ff5243e41
BLAKE2b-256 checksum
How to use checksums
91c649358a3985f1051e9374e39840bcf7956ede588b8f1c8c190f7d06d4c800
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.10.14

Release files / groqchat-0.0.17-py3-none-any.whl

Download URL groqchat-0.0.17-py3-none-any.whl
Size 25.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
988af825e25027f1c59658e640636b33b90cb3e8ea2277344141c3bc84f9e697
BLAKE2b-256 checksum
How to use checksums
938d931e58c8caee6dd63df21f6e7e593b8053403557bb252c1de9f9d814e1bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.10.14

Release history Release notifications | RSS feed

This release

0.0.17 This release

2 release files

0.0.15

2 release files

0.0.14

2 release files

0.0.13

2 release files

0.0.12

2 release files

0.0.11

2 release files

0.0.10

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page