Update README.md

This commit is contained in:
tofasthacker 2024-01-04 01:49:55 +00:00
parent 0c4fafbfb6
commit 2065905af5

View File

@ -1,3 +1,29 @@
# askai
This is a program called askai. It takes in data from the user through stdin and arguments. It then uses it to generate responses. For example, if you input some log files and ask it a question about what happened in those log files.
## Overview
askai is an interactive Linux tool that processes data from stdin according to user-specified instructions. It utilizes LangChain's Ollama model for generating responses.
## Usage
To use the tool, simply input your information through stdin and pass your command line argument as a parameter. If you want to save default settings or update them, run the code with `--config` flag.
## Installation
To install this tool first create a venv python enviorment.
```bash
python3 -m venv askai
```
Next download the repository and install askai.
```bash
git clone https://gitea.locker98.com/tofasthacker/askai.git
cd askai
pip install -r requirements.txt
sudo cp askai /bin/askai
askai --config
```
## Example Usage
```bash
echo "This is some data" | askai "Discribe the input" --config
```