Skip to content

Commit a8a9f5b

Browse files
committed
Update README.md
1 parent 1c22406 commit a8a9f5b

File tree

1 file changed

+53
-18
lines changed

1 file changed

+53
-18
lines changed

README.md

Lines changed: 53 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
11
# Clibot
22

3+
[![PyPI version](https://badge.fury.io/py/clibot.svg)](https://badge.fury.io/py/clibot)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5+
[![Python Versions](https://img.shields.io/pypi/pyversions/clibot.svg)](https://pypi.org/project/clibot/)
6+
37
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.
48

5-
https://github.com/user-attachments/assets/320cd140-4949-46e5-88ba-ba4f9e2e0f96
9+
![Clibot Demo](https://github.com/user-attachments/assets/6cb76ad5-3a8d-4bd9-9068-6ec4f99793d0)
610

711
## Features
812

9-
- **Multi-Provider Support**: Compatible with multiple AI providers including Groq, OpenAI, Mistral, and Ollama.
10-
- **Conversation History**: Keeps track of your conversations for easy review.
11-
- **Setup and Configuration**: Streamlined setup process to configure your AI providers.
12-
- **Asynchronous Processing**: Utilizes asynchronous operations for improved performance.
13-
- **Error Handling**: Robust error handling and retry mechanisms for a smooth user experience.
14-
- **Customizable Settings**: Adjust AI model parameters like temperature and max tokens.
13+
- 🌐 **Multi-Provider Support**: Compatible with multiple AI providers including Groq, OpenAI, Mistral, and Ollama.
14+
- 💬 **Conversation History**: Keeps track of your conversations for easy review.
15+
- 🔧 **Setup and Configuration**: Streamlined setup process to configure your AI providers.
16+
-**Asynchronous Processing**: Utilizes asynchronous operations for improved performance.
17+
- 🛡️ **Error Handling**: Robust error handling and retry mechanisms for a smooth user experience.
18+
- ⚙️ **Customizable Settings**: Adjust AI model parameters like temperature and max tokens.
19+
- 💾 **File Saving**: Save files directly from Clibot responses.
20+
- 🖥️ **Terminal Command Execution**: Execute terminal commands through Clibot.
21+
- 🐍 **Python Code Execution**: Run Python code snippets within Clibot.
1522

1623
## Installation
1724

18-
To install Clibot, run the following command:
25+
Install Clibot using pip:
1926

2027
```bash
2128
pip install clibot
@@ -24,48 +31,76 @@ pip install clibot
2431
> [!TIP]
2532
> 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).
2633
>
27-
> **❗️Note: Localhosted models require high-end hardware for optimal performance and may not work as expected on lower-end systems.**
34+
> **❗️Note: Locally hosted models require high-end hardware for optimal performance and may not work as expected on lower-end systems.**
35+
36+
## Getting Started
2837

2938
### Setup
3039

31-
After installation, run the following command to set up Clibot:
40+
After installation, set up Clibot by running:
3241

3342
```bash
3443
clibot
3544
```
3645

37-
### Usage
46+
Follow the prompts to configure your AI providers and preferences.
3847

39-
Use Clibot by executing the `clibot` command followed by your query or command. Here are some examples:
48+
### Basic Usage
4049

41-
- General Queries:
50+
Use Clibot by executing the `clibot` command followed by your query or command:
4251

4352
```bash
4453
clibot "How is my system?"
4554
```
4655

47-
- Summarizing multiple files:
56+
## Advanced Usage
57+
58+
### Summarizing Multiple Files
4859

4960
```bash
5061
clibot "Summarize" < file1.txt < file2.txt
5162
```
5263

53-
- Creating and saving files:
64+
### Creating and Saving Files
5465

5566
```bash
5667
clibot 'Write a simple README file' > README.md
5768
```
5869

59-
- Reviewing CPU information:
70+
### Reviewing System Information
6071

6172
```bash
6273
lscpu | clibot 'Review my CPU'
6374
```
6475

65-
Feel free to explore the various capabilities of Clibot and make the most out of this powerful command-line productivity tool!
76+
### Saving Files from Clibot Responses
77+
78+
```bash
79+
clibot "Create a simple Python script that prints 'Hello, World!' and save it as hello.py"
80+
```
81+
82+
### Executing Terminal Commands
83+
84+
```bash
85+
clibot "Show me the contents of the current directory"
86+
```
87+
88+
### Running Python Code
89+
90+
```bash
91+
clibot "Calculate the factorial of 5 using Python"
92+
```
6693

67-
### Donations
94+
## Support
95+
96+
If you encounter any issues or have questions, please [open an issue](https://github.com/linuztx/clibot/issues) on GitHub.
97+
98+
## Donations
6899

69100
If you find this project useful, consider supporting my work by making a donation. Every contribution helps me continue developing and maintaining this project.
70101

71102
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/linuztx)
103+
104+
## License
105+
106+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)