added readme

This commit is contained in:
test 2024-01-20 20:49:57 -05:00
parent a17bb46153
commit 76cdd16a88
2 changed files with 23 additions and 0 deletions

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# llmcmd
llmcmd is an interactive Linux tool that takes natural language and turns it into oneliner bash commands. This tool utilizes Ollama with codellama:7b for snappy usefull responses. It has built in self reflection so that it reflects on the code to make sure that it is correctly fromated and does not include any error. If it determines that the code is correct the it shows it to the user. Otherwise it tryes again. If it is unable to find a useful result after 5 attempts it will through an error say it can not find a sollution.
## Usage
To use the tool, simply type `llmcmd` the double quotes and your question. Once it has generated the code then you can choose one of 4 options:
- n for skipping the code block (default)
- y for running the code block as is.
- e for editing the code block before running.
- q for ending the tool emedialtly
## Installation
To install this tool first create a venv python enviorment.
```bash
git clone https://gitea.locker98.com/tofasthacker/llm_cmd.git
cd llm_cmd
```
## Example Usage
```bash
python3 llmcmd "how do I update my computer"
```

View File

@ -127,3 +127,4 @@ for code in soup.findAll('code'):
os.system(f"rm -rf {t.name}")
elif answer == "d" or answer == "done":
exit()