# 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:
```bash
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "groqshell-cli",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, groq, ai, cli, shell, interface",
"author": "Revaz Goguadze",
"author_email": "<goguadze.rezi2022@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/92/b2/2859b345462eb9af6872d976fdac96bcad09bd23e29898910bdc38736020/groqshell_cli-0.0.22.tar.gz",
"platform": null,
"description": "\n# GroqShell\n\nWelcome 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.\n\n## \ud83c\udf1f Features\n\n- **Command-Line Interaction**: Engage with Groq AI models directly from your terminal.\n- **Model Selection**: Choose from a variety of available Groq models.\n- **JSON Output**: Easily force JSON output for structured responses.\n- **Persistent Model Selection**: Your selected model is remembered for future sessions.\n- **Interactive Mode**: Enjoy a continuous conversation with the AI.\n- **Markdown Formatting**: Responses are beautifully formatted in Markdown.\n- **Syntax Highlighting**: Code blocks are highlighted for better readability.\n- **Command History Support**: Navigate through your command history effortlessly.\n\n## \ud83d\ude80 Installation\n\nTo get started with GroqShell, follow these simple steps:\n\n1. Install the package using pip:\n\n ```bash\n pip install groqshell-cli\n ```\n\n## Usage\n\nBefore using **GroqShell**, make sure to set your **Groq API key** as an environment variable:\n\n```\nexport GROQ_API_KEY='your-api-key-here'\n```\n\n**Basic usage:**\n\n```\ngroqshell -p \"Your prompt here\"\n```\n\n**Force JSON output:**\n\n```\ngroqshell -p \"Your prompt here\" -j\n```\n\n**Select a different Groq model:**\n\n```\ngroqshell -m\n```\n\n**List available Groq models:**\n\n```\ngroqshell -l\n```\n\n**Enter interactive mode:**\n\n```\ngroqshell -I\n```\n\n## \ud83d\udd0d Options\n\n- `-p`, `--prompt`: The prompt to send to the Groq AI model (required)\n- `-j`, `--json`: Force JSON output\n- `-c`, `--change`: Change the Groq model\n- `-i`, `--info`: Get information about the currently selected model\n- `-l`, `--list`: List available Groq models\n- `-I`, `--interactive`: Enter interactive mode for continuous conversation\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## \ud83d\udcdc License\n\nThis project is licensed under the MIT License.\n",
"bugtrack_url": null,
"license": null,
"summary": "Command-line interface for Groq AI models",
"version": "0.0.22",
"project_urls": null,
"split_keywords": [
"python",
" groq",
" ai",
" cli",
" shell",
" interface"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b45661de479465701a712effc4ef058ec15744784f410433506c5f02d4b57bd",
"md5": "3f519194d3a0406a3e1b6f013ea2b3bf",
"sha256": "1469c23a34857f5a290ed05fdaea445570b45946f2b3c05a7137cc981279eb1e"
},
"downloads": -1,
"filename": "groqshell_cli-0.0.22-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3f519194d3a0406a3e1b6f013ea2b3bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5039,
"upload_time": "2024-10-25T18:08:24",
"upload_time_iso_8601": "2024-10-25T18:08:24.621926Z",
"url": "https://files.pythonhosted.org/packages/2b/45/661de479465701a712effc4ef058ec15744784f410433506c5f02d4b57bd/groqshell_cli-0.0.22-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "92b22859b345462eb9af6872d976fdac96bcad09bd23e29898910bdc38736020",
"md5": "98db7aa757fb70b6bd5d56e0de82afb2",
"sha256": "93c70bf23b50cc58d71305a042ef2113f13b357d25fe34e6d2c2f392374bdaf7"
},
"downloads": -1,
"filename": "groqshell_cli-0.0.22.tar.gz",
"has_sig": false,
"md5_digest": "98db7aa757fb70b6bd5d56e0de82afb2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4704,
"upload_time": "2024-10-25T18:08:26",
"upload_time_iso_8601": "2024-10-25T18:08:26.790399Z",
"url": "https://files.pythonhosted.org/packages/92/b2/2859b345462eb9af6872d976fdac96bcad09bd23e29898910bdc38736020/groqshell_cli-0.0.22.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 18:08:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "groqshell-cli"
}
JSON