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 0.0.21

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

Built distribution (wheel)

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

Release files / groqshell-0.0.21-py3-none-any.whl

Download URL groqshell-0.0.21-py3-none-any.whl
Size 5.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5e63d2b6bd6313e8a2cf589b16a192904a8a692574b8ac44520779a9141d0403
BLAKE2b-256 checksum
How to use checksums
fdac4b16c9a06dabab4b09fc5a62be1301c81e4c10cf6b6cfa9bf6cba5cd96db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.7

Security for groqshell 0.0.21

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.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.21 This release

1 release file No provenance

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