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 rgroq 2.3.0

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

Source distribution (sdist)

Source distribution for rgroq 2.3.0
File Size Uploaded Provenance
rgroq-2.3.0.tar.gz 25.0 kB Without provenance Details

Built distribution (wheel)

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

Total release size: 51.0 kB

Release files / rgroq-2.3.0.tar.gz

Download URL rgroq-2.3.0.tar.gz
Size 25.0 kB
Tags Source
SHA-256 checksum
How to use checksums
7fdd3b3cb9e91e70530f8d30d90e3a013ca0848bd84b105eaee5732f2d61774e
BLAKE2b-256 checksum
How to use checksums
a72ab1944bae318c20096937a2f405dc5d1fcb4e381d4c22e214c0b9bd38b7f7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.8

Release files / rgroq-2.3.0-py3-none-any.whl

Download URL rgroq-2.3.0-py3-none-any.whl
Size 26.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
16b2e3dca533b31a8337f077253978e7ed81a878ad076c8820729a876ca0d8e1
BLAKE2b-256 checksum
How to use checksums
ec391e3104ad65035aff9eaf931fb2e61a1cdf8ab763dcc25390ebc97e4d6635
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.8

Security for rgroq 2.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

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