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 Distribution

groqshell_cli-0.0.22.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

groqshell_cli-0.0.22-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file groqshell_cli-0.0.22.tar.gz.

File metadata

  • Download URL: groqshell_cli-0.0.22.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.7

File hashes

Hashes for groqshell_cli-0.0.22.tar.gz
Algorithm Hash digest
SHA256 93c70bf23b50cc58d71305a042ef2113f13b357d25fe34e6d2c2f392374bdaf7
MD5 98db7aa757fb70b6bd5d56e0de82afb2
BLAKE2b-256 92b22859b345462eb9af6872d976fdac96bcad09bd23e29898910bdc38736020

See more details on using hashes here.

File details

Details for the file groqshell_cli-0.0.22-py3-none-any.whl.

File metadata

File hashes

Hashes for groqshell_cli-0.0.22-py3-none-any.whl
Algorithm Hash digest
SHA256 1469c23a34857f5a290ed05fdaea445570b45946f2b3c05a7137cc981279eb1e
MD5 3f519194d3a0406a3e1b6f013ea2b3bf
BLAKE2b-256 2b45661de479465701a712effc4ef058ec15744784f410433506c5f02d4b57bd

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