# Ragbits CLI
Ragbits CLI provides the `ragbits` command-line interface (CLI) tool that allows you to interact with Ragbits from the terminal. Other packages can extend the CLI by adding their own commands, so the exact set of available commands may vary depending on the installed packages.
## Installation
To use the complete Ragbits stack, install the `ragbits` package:
```sh
pip install ragbits
```
## Example Usage
The following example assumes that `ragbits-core` is installed and that the current ddirectory contains a `song_prompt.py` file with a prompt class named `SongPrompt`, as defined in the [Quickstart Guide](https://ragbits.deepsense.ai/quickstart/quickstart1_prompts/#making-the-prompt-dynamic).
The example demonstrates how to execute the prompt using the `ragbits` CLI tool.
The left side of the table shows the system and user prompts (rendered with placeholders replaced by the provided values), and the right side shows the generated response from the Large Language Model.
```sh
$ ragbits prompts exec song_prompt:SongPrompt --payload '{"subject": "unicorns", "age_group": 12, "genre": "pop"}'
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Question ┃ Answer ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ [{'role': 'system', 'content': 'You │ (Verse 1) │
│ are a professional songwriter. │ In a land of rainbows and glitter, │
│ You only use language that is │ Where flowers bloom and skies are │
│ appropriate for children.'}, │ brighter, │
│ {'role': 'user', 'content': 'Write a │ There's a magical creature so rare, │
│ song about a unicorns for 12 years │ With a horn that sparkles in the air. │
│ old pop fans.'}] │ │
│ │ (Chorus) │
│ │ Unicorns, unicorns, oh so divine, │
│ │ With their mane that shines and eyes │
│ │ that shine, │
│ │ Gallop through the meadows, so free, │
│ │ In a world of wonder, just you and │
│ │ me. │
└───────────────────────────────────────┴───────────────────────────────────────┘
```
## Documentation
* [Documentation of the `ragbits` CLI](https://ragbits.deepsense.ai/cli/main/)
Raw data
{
"_id": null,
"home_page": null,
"name": "ragbits-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "GenAI, Generative AI, LLMs, Large Language Models, Prompt Management, RAG, Retrieval Augmented Generation",
"author": null,
"author_email": "\"deepsense.ai\" <ragbits@deepsense.ai>",
"download_url": "https://files.pythonhosted.org/packages/e8/56/266b61f50dd4d246412bf42af7b9e6d443cce74403bbe66fa561dd18e96a/ragbits_cli-1.1.0.tar.gz",
"platform": null,
"description": "# Ragbits CLI\n\nRagbits CLI provides the `ragbits` command-line interface (CLI) tool that allows you to interact with Ragbits from the terminal. Other packages can extend the CLI by adding their own commands, so the exact set of available commands may vary depending on the installed packages.\n\n## Installation\n\nTo use the complete Ragbits stack, install the `ragbits` package:\n\n```sh\npip install ragbits\n```\n\n## Example Usage\nThe following example assumes that `ragbits-core` is installed and that the current ddirectory contains a `song_prompt.py` file with a prompt class named `SongPrompt`, as defined in the [Quickstart Guide](https://ragbits.deepsense.ai/quickstart/quickstart1_prompts/#making-the-prompt-dynamic).\n\nThe example demonstrates how to execute the prompt using the `ragbits` CLI tool.\nThe left side of the table shows the system and user prompts (rendered with placeholders replaced by the provided values), and the right side shows the generated response from the Large Language Model.\n\n```sh\n$ ragbits prompts exec song_prompt:SongPrompt --payload '{\"subject\": \"unicorns\", \"age_group\": 12, \"genre\": \"pop\"}'\n\n\u250f\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2513\n\u2503 Question \u2503 Answer \u2503\n\u2521\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2529\n\u2502 [{'role': 'system', 'content': 'You \u2502 (Verse 1) \u2502\n\u2502 are a professional songwriter. \u2502 In a land of rainbows and glitter, \u2502\n\u2502 You only use language that is \u2502 Where flowers bloom and skies are \u2502\n\u2502 appropriate for children.'}, \u2502 brighter, \u2502\n\u2502 {'role': 'user', 'content': 'Write a \u2502 There's a magical creature so rare, \u2502\n\u2502 song about a unicorns for 12 years \u2502 With a horn that sparkles in the air. \u2502\n\u2502 old pop fans.'}] \u2502 \u2502\n\u2502 \u2502 (Chorus) \u2502\n\u2502 \u2502 Unicorns, unicorns, oh so divine, \u2502\n\u2502 \u2502 With their mane that shines and eyes \u2502\n\u2502 \u2502 that shine, \u2502\n\u2502 \u2502 Gallop through the meadows, so free, \u2502\n\u2502 \u2502 In a world of wonder, just you and \u2502\n\u2502 \u2502 me. \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n```\n\n## Documentation\n* [Documentation of the `ragbits` CLI](https://ragbits.deepsense.ai/cli/main/)\n",
"bugtrack_url": null,
"license": null,
"summary": "A CLI application for ragbits - building blocks for rapid development of GenAI applications",
"version": "1.1.0",
"project_urls": {
"Bug Reports": "https://github.com/deepsense-ai/ragbits/issues",
"Documentation": "https://ragbits.deepsense.ai/",
"Homepage": "https://github.com/deepsense-ai/ragbits",
"Source": "https://github.com/deepsense-ai/ragbits"
},
"split_keywords": [
"genai",
" generative ai",
" llms",
" large language models",
" prompt management",
" rag",
" retrieval augmented generation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4ceb8213f687b5bb14422bee3642c02a2bc5f34fa4da64df3ef4286da342564b",
"md5": "117e70f3c6cad82b8240aa3190553572",
"sha256": "bd8d647c26dcb230ada7d50cb7a17f985455177a4fe966be422aae8a2b07e852"
},
"downloads": -1,
"filename": "ragbits_cli-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "117e70f3c6cad82b8240aa3190553572",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7157,
"upload_time": "2025-07-09T15:46:02",
"upload_time_iso_8601": "2025-07-09T15:46:02.072335Z",
"url": "https://files.pythonhosted.org/packages/4c/eb/8213f687b5bb14422bee3642c02a2bc5f34fa4da64df3ef4286da342564b/ragbits_cli-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e856266b61f50dd4d246412bf42af7b9e6d443cce74403bbe66fa561dd18e96a",
"md5": "e872a0452369690467a2718d80d3c3d1",
"sha256": "8a1461d0d839363dee857490d3002b2521ca3f54d364113bb4a9b9a48905930f"
},
"downloads": -1,
"filename": "ragbits_cli-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "e872a0452369690467a2718d80d3c3d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 8215,
"upload_time": "2025-07-09T15:46:10",
"upload_time_iso_8601": "2025-07-09T15:46:10.086594Z",
"url": "https://files.pythonhosted.org/packages/e8/56/266b61f50dd4d246412bf42af7b9e6d443cce74403bbe66fa561dd18e96a/ragbits_cli-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 15:46:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deepsense-ai",
"github_project": "ragbits",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ragbits-cli"
}
JSON
