diff --git a/README.md b/README.md index ac2037b..3db4a3b 100644 --- a/README.md +++ b/README.md @@ -1 +1,92 @@ -AI console agent +# ConsoleX 2.4.13 - Lokaal console-agent voor je LLM Proxy + +ConsoleX is een lokale agent die interactie mogelijk maakt met een LLM (Large Language Model) proxy via verschillende tools zoals bestandbeheer, shell-uitvoering en webzoeken. + +## Features ✨ +- **Bestandsmanipulatie**: Lees, schrijf, bijwerk en zoek in tekstbestanden. +- **Shell-ondersteuning**: Voer command-line commando's uit met opties als tijdsbeperking (timeout) en werkdirectory (cwd). +- **Webzoek tools**: Zoeken op het web via Google, SerpAPI of DuckDuckGo backends. +- **Background modus**: Stel vragen aan de gebruiker in background-modus voor geautomatiseerde workflows. +- **RAG ondersteuning**: Beheer en zoek naar lokale RAG (Retrieval Augmented Generation) documenten. +- **Task management**: Werk met doelen, taken en statusupdates. + +## Installatie & Configuratie 🛠️ + +1. **Voorkeure configureren** via milieueigen variabelen: + - `CONSOLEX_BASE_URL`: URL van je LLM proxy (default: `http://localhost:8080/v1`) + - `MODEL` : Naam van het model dat gebruikt wordt door de proxy. + - `TIMEOUT_S`: Tijdsbeperking voor tool-uitvoering in seconden. + +2. **Installatie** via pip (als nodig): +```bash +pip install httpx beautifulsoup4 rich +``` + +## Gebruik 📌 + +### Starter de agent op: +```bash +python3 ConsoleX_2_4_13.py +``` + +### Commanden in het REPL interface: + +- **Background jobs toevoegen**: + ```bash + :add "Voer een command uit" + ``` + +- **Status weergeven van taken en doelen** : + ``` + :status + :tasks + ``` + +- **Webzoek verrichten** : + ```bash + :tool web_search - query="Python best practices" max_results=3 + ``` + +### Voorbeelden: +1. Een tekstbestand lezen: +```python +t_read_file({"path": "example.txt"}) +``` +2. Shell commando uitvoeren (met werkdirectory): + ```python + t_run_shell({ + "command": "ls -l", + "cwd": "/home/user/projects" + }) + ``` + +## Configuratie Opties 📋 + +- **Verbale informatie** : + ```bash + :v [0-3] (0: stil, 1: normaal, 2: gedetailleerd, 3: debug) + ``` +- **Background modus aan/uit**: + ```bash + :bg on|off + ``` + +## Veranderingen ten opzichte van versie 2.4.12 🔄 + +- `ask_user` werkt nu ook in background (BG) modus: + - Tijdens een BG-job wordt de vraag met een ID getoond: `[ask_user] job vraag : ` + Antwoordtje via `:answer `. +- Foreground-modus werkt nog steeds als gewoon input. + +## Documentatie & Support 📚 + +Voor meer informatie over de API en beschikbare tools, raadpleeg het script `ConsoleX_2_4_13.py` voor details in de functies zoals: +```python +tool_schema() # Lijst van alle beschikbare tools. +t_read_file(), t_write_file(), etc. # Bestandsbeheer functies. +``` + +## Licentie 📜 + +Open source, vrij om te gebruiken en aan te passen onder MIT licentie. +