You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
-**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.
15
22
16
23
## Installation
17
24
18
-
To install Clibot, run the following command:
25
+
Install Clibot using pip:
19
26
20
27
```bash
21
28
pip install clibot
@@ -24,48 +31,76 @@ pip install clibot
24
31
> [!TIP]
25
32
> 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).
26
33
>
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
28
37
29
38
### Setup
30
39
31
-
After installation, run the following command to set up Clibot:
40
+
After installation, set up Clibot by running:
32
41
33
42
```bash
34
43
clibot
35
44
```
36
45
37
-
### Usage
46
+
Follow the prompts to configure your AI providers and preferences.
38
47
39
-
Use Clibot by executing the `clibot` command followed by your query or command. Here are some examples:
48
+
### Basic Usage
40
49
41
-
- General Queries:
50
+
Use Clibot by executing the `clibot` command followed by your query or command:
42
51
43
52
```bash
44
53
clibot "How is my system?"
45
54
```
46
55
47
-
- Summarizing multiple files:
56
+
## Advanced Usage
57
+
58
+
### Summarizing Multiple Files
48
59
49
60
```bash
50
61
clibot "Summarize"< file1.txt < file2.txt
51
62
```
52
63
53
-
- Creating and saving files:
64
+
###Creating and Saving Files
54
65
55
66
```bash
56
67
clibot 'Write a simple README file'> README.md
57
68
```
58
69
59
-
- Reviewing CPU information:
70
+
###Reviewing System Information
60
71
61
72
```bash
62
73
lscpu | clibot 'Review my CPU'
63
74
```
64
75
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
+
```
66
93
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
68
99
69
100
If you find this project useful, consider supporting my work by making a donation. Every contribution helps me continue developing and maintaining this project.
0 commit comments