Skip to main content

GroqShell

Welcome to GroqShell, a powerful command-line interface designed for seamless interaction with Groq AI models. With GroqShell, you can effortlessly send prompts to Groq models and receive instant responses right in your terminal.

🌟 Features

  • Command-Line Interaction: Engage with Groq AI models directly from your terminal.
  • Model Selection: Choose from a variety of available Groq models.
  • JSON Output: Easily force JSON output for structured responses.
  • Persistent Model Selection: Your selected model is remembered for future sessions.
  • Interactive Mode: Enjoy a continuous conversation with the AI.
  • Markdown Formatting: Responses are beautifully formatted in Markdown.
  • Syntax Highlighting: Code blocks are highlighted for better readability.
  • Command History Support: Navigate through your command history effortlessly.

🚀 Installation

To get started with GroqShell, follow these simple steps:

  1. Install the package using pip:

    pip install groqshell-cli
    

Usage

Before using GroqShell, make sure to set your Groq API key as an environment variable:

export GROQ_API_KEY='your-api-key-here'

Basic usage:

groqshell -p "Your prompt here"

Force JSON output:

groqshell -p "Your prompt here" -j

Select a different Groq model:

groqshell -m

List available Groq models:

groqshell -l

Enter interactive mode:

groqshell -I

🔍 Options

  • -p, --prompt: The prompt to send to the Groq AI model (required)
  • -j, --json: Force JSON output
  • -c, --change: Change the Groq model
  • -i, --info: Get information about the currently selected model
  • -l, --list: List available Groq models
  • -I, --interactive: Enter interactive mode for continuous conversation

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📜 License

This project is licensed under the MIT License.

Metadata

Release files for groqshell-cli 0.0.22

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

Source distribution (sdist)

Source distribution for groqshell-cli 0.0.22
File Size Uploaded
groqshell_cli-0.0.22.tar.gz 4.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for groqshell-cli 0.0.22
File Interpreter ABI Platform
groqshell_cli-0.0.22-py3-none-any.whl Python 3 none any Details

Total release size: 9.7 kB

Release files / groqshell_cli-0.0.22.tar.gz

Download URL groqshell_cli-0.0.22.tar.gz
Size 4.7 kB
Tags Source
SHA-256 checksum
How to use checksums
93c70bf23b50cc58d71305a042ef2113f13b357d25fe34e6d2c2f392374bdaf7
BLAKE2b-256 checksum
How to use checksums
92b22859b345462eb9af6872d976fdac96bcad09bd23e29898910bdc38736020
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.7

Release files / groqshell_cli-0.0.22-py3-none-any.whl

Download URL groqshell_cli-0.0.22-py3-none-any.whl
Size 5.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1469c23a34857f5a290ed05fdaea445570b45946f2b3c05a7137cc981279eb1e
BLAKE2b-256 checksum
How to use checksums
2b45661de479465701a712effc4ef058ec15744784f410433506c5f02d4b57bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.7

Release history Release notifications | RSS feed

This release

0.0.22 This release

2 release files

0.0.21

1 release file

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