| Name | clibot JSON |
| Version |
0.1.4.1
JSON |
| download |
| home_page | https://github.com/linuztx/clibot |
| Summary | An innovative command-line tool driven by powerful large language models, designed to accelerate task completion and maximize your productivity. |
| upload_time | 2024-10-09 02:14:11 |
| maintainer | None |
| docs_url | None |
| author | linuztx |
| requires_python | >=3.6 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Clibot
Clibot is an innovative command-line productivity tool powered by advanced language models. It helps you accomplish tasks faster and more efficiently by interacting with AI models directly from the command line. Clibot supports various command line interfaces including CMD, PowerShell, Zsh, and more.
https://github.com/user-attachments/assets/320cd140-4949-46e5-88ba-ba4f9e2e0f96
## Features
- **Multi-Provider Support**: Compatible with multiple AI providers including Groq, OpenAI, Mistral, and Ollama.
- **Conversation History**: Keeps track of your conversations for easy review.
- **Setup and Configuration**: Streamlined setup process to configure your AI providers.
- **Asynchronous Processing**: Utilizes asynchronous operations for improved performance.
- **Error Handling**: Robust error handling and retry mechanisms for a smooth user experience.
- **Customizable Settings**: Adjust AI model parameters like temperature and max tokens.
## Installation
To install Clibot, run the following command:
```bash
pip install clibot
```
> [!TIP]
> You can use locally hosted open source models which are available for free. To use local models, you will need to run your own LLM backend server such as [Ollama](https://github.com/ollama/ollama).
>
> **❗️Note: Localhosted models require high-end hardware for optimal performance and may not work as expected on lower-end systems.**
### Setup
After installation, run the following command to set up Clibot:
```bash
clibot
```
### Usage
Use Clibot by executing the `clibot` command followed by your query or command. Here are some examples:
- General Queries:
```bash
clibot "How is my system?"
```
- Summarizing multiple files:
```bash
clibot "Summarize" < file1.txt < file2.txt
```
- Creating and saving files:
```bash
clibot 'Write a simple README file' > README.md
```
- Reviewing CPU information:
```bash
lscpu | clibot 'Review my CPU'
```
Feel free to explore the various capabilities of Clibot and make the most out of this powerful command-line productivity tool!
### Donations
If you find this project useful, consider supporting my work by making a donation. Every contribution helps me continue developing and maintaining this project.
[](https://ko-fi.com/linuztx)
Raw data
{
"_id": null,
"home_page": "https://github.com/linuztx/clibot",
"name": "clibot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "linuztx",
"author_email": "linuztx@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/44/74/be991b6306e48b3bd95b032f3305ac6b37564717cd82c153e1e12701a2e3/clibot-0.1.4.1.tar.gz",
"platform": null,
"description": "# Clibot\n\nClibot is an innovative command-line productivity tool powered by advanced language models. It helps you accomplish tasks faster and more efficiently by interacting with AI models directly from the command line. Clibot supports various command line interfaces including CMD, PowerShell, Zsh, and more.\n\nhttps://github.com/user-attachments/assets/320cd140-4949-46e5-88ba-ba4f9e2e0f96\n\n## Features\n\n- **Multi-Provider Support**: Compatible with multiple AI providers including Groq, OpenAI, Mistral, and Ollama.\n- **Conversation History**: Keeps track of your conversations for easy review.\n- **Setup and Configuration**: Streamlined setup process to configure your AI providers.\n- **Asynchronous Processing**: Utilizes asynchronous operations for improved performance.\n- **Error Handling**: Robust error handling and retry mechanisms for a smooth user experience.\n- **Customizable Settings**: Adjust AI model parameters like temperature and max tokens.\n\n## Installation\n\nTo install Clibot, run the following command:\n\n```bash\npip install clibot\n```\n\n> [!TIP]\n> You can use locally hosted open source models which are available for free. To use local models, you will need to run your own LLM backend server such as [Ollama](https://github.com/ollama/ollama).\n>\n> **\u2757\ufe0fNote: Localhosted models require high-end hardware for optimal performance and may not work as expected on lower-end systems.**\n\n### Setup\n\nAfter installation, run the following command to set up Clibot:\n\n```bash\nclibot\n```\n\n### Usage\n\nUse Clibot by executing the `clibot` command followed by your query or command. Here are some examples:\n\n- General Queries:\n\n```bash\nclibot \"How is my system?\"\n```\n\n- Summarizing multiple files:\n\n```bash\nclibot \"Summarize\" < file1.txt < file2.txt\n```\n\n- Creating and saving files:\n\n```bash\nclibot 'Write a simple README file' > README.md\n```\n\n- Reviewing CPU information:\n\n```bash\nlscpu | clibot 'Review my CPU'\n```\n\nFeel free to explore the various capabilities of Clibot and make the most out of this powerful command-line productivity tool!\n\n### Donations\n\nIf you find this project useful, consider supporting my work by making a donation. Every contribution helps me continue developing and maintaining this project.\n\n[](https://ko-fi.com/linuztx)\n",
"bugtrack_url": null,
"license": null,
"summary": "An innovative command-line tool driven by powerful large language models, designed to accelerate task completion and maximize your productivity.",
"version": "0.1.4.1",
"project_urls": {
"Homepage": "https://github.com/linuztx/clibot"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dfca8ec894923807d8aa7b12e3bcc60b658a86ca25c887f67723051e5d730ed8",
"md5": "d71058fd69c032cb17397dbb4ac7b5f4",
"sha256": "93aee29ca0eea100d5854e833df3c865cc912ed845e5de304fd30f9020fb0504"
},
"downloads": -1,
"filename": "clibot-0.1.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d71058fd69c032cb17397dbb4ac7b5f4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12640,
"upload_time": "2024-10-09T02:14:10",
"upload_time_iso_8601": "2024-10-09T02:14:10.175511Z",
"url": "https://files.pythonhosted.org/packages/df/ca/8ec894923807d8aa7b12e3bcc60b658a86ca25c887f67723051e5d730ed8/clibot-0.1.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4474be991b6306e48b3bd95b032f3305ac6b37564717cd82c153e1e12701a2e3",
"md5": "e21a8479c57c1e543400b1ffdf3b9b4f",
"sha256": "b251a926a743166868df367174c336b424f65afee3ff9480423fe58d2c672232"
},
"downloads": -1,
"filename": "clibot-0.1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "e21a8479c57c1e543400b1ffdf3b9b4f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 11437,
"upload_time": "2024-10-09T02:14:11",
"upload_time_iso_8601": "2024-10-09T02:14:11.709491Z",
"url": "https://files.pythonhosted.org/packages/44/74/be991b6306e48b3bd95b032f3305ac6b37564717cd82c153e1e12701a2e3/clibot-0.1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 02:14:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "linuztx",
"github_project": "clibot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "clibot"
}
