Skip to main content

Command-line interface for Groq AI models

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

groqshell-0.0.21-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file groqshell-0.0.21-py3-none-any.whl.

File metadata

  • Download URL: groqshell-0.0.21-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.7

File hashes

Hashes for groqshell-0.0.21-py3-none-any.whl
Algorithm Hash digest
SHA256 5e63d2b6bd6313e8a2cf589b16a192904a8a692574b8ac44520779a9141d0403
MD5 cf67042680c4b3ea64dddbf38cf0edd2
BLAKE2b-256 fdac4b16c9a06dabab4b09fc5a62be1301c81e4c10cf6b6cfa9bf6cba5cd96db

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page