docs: riscrive QUICKSTART.md completo con tutte le funzionalità
- Chat interattiva, Server web, Dashboard, API - CLI configurazione, TUI, Analytics - Comandi memory, planning, skills - Struttura progetto e troubleshooting
This commit is contained in:
1 parent
122ad6930b
commit
4de50a1712
1 file changed
+150
-54
+150
-54
@@ -1,102 +1,198 @@
|
||||
# Guida Rapida - LangCode Agent
|
||||
# LangCode Agent - Guida Rapida
|
||||
|
||||
Installazione veloce su una macchina nuova.
|
||||
|
||||
## 1. Clona il Repository
|
||||
## Installazione
|
||||
|
||||
```bash
|
||||
# 1. Clona il repository
|
||||
git clone http://192.168.0.183:8085/truetype/langcode_agent.git
|
||||
cd langcode_agent
|
||||
```
|
||||
|
||||
## 2. Crea Virtual Environment (consigliato)
|
||||
|
||||
```bash
|
||||
# 2. Crea e attiva virtual environment
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
```
|
||||
|
||||
## 3. Installa Dipendenze
|
||||
|
||||
```bash
|
||||
# 3. Installa dipendenze
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## 4. Configura Ollama (o altro provider)
|
||||
---
|
||||
|
||||
## Configurazione Rapida
|
||||
|
||||
### Opzione A: Variabili d'ambiente (veloce)
|
||||
```bash
|
||||
# Imposta variabili d'ambiente
|
||||
export MODEL_PROVIDER=ollama
|
||||
export MODEL_NAME=gemma2:9b
|
||||
export OLLAMA_BASE_URL=http://192.168.0.50:11434
|
||||
```
|
||||
|
||||
### Opzione B: Configurazione persistente
|
||||
```bash
|
||||
# Avvia la CLI
|
||||
python langcode.py
|
||||
|
||||
# Nella CLI interattiva:
|
||||
/config add -n mio-ollama -p ollama -m gemma2:9b -u http://192.168.0.50:11434
|
||||
/config use mio-ollama
|
||||
/exit
|
||||
```
|
||||
|
||||
## 5. Avvia l'Agent
|
||||
Oppure usa la CLI interattiva per salvare configurazioni persistenti:
|
||||
|
||||
```bash
|
||||
# Modalità chat interattiva
|
||||
python langcode.py
|
||||
|
||||
# Oppure direttamente
|
||||
python main.py
|
||||
langcode config add -n ollama -p ollama -m gemma2:9b -u http://192.168.0.50:11434 --set-active
|
||||
langcode config test
|
||||
```
|
||||
|
||||
## 6. Comandi Utili
|
||||
---
|
||||
|
||||
```
|
||||
/help - Mostra aiuto
|
||||
/status - Stato sistema
|
||||
/memory remember <testo> - Salva un fatto
|
||||
/memory recall <query> - Cerca nella memoria
|
||||
/plan create <nome> "<task1; task2>" - Crea piano
|
||||
/exit - Esci
|
||||
```
|
||||
## Modalità di Utilizzo
|
||||
|
||||
## Troubleshooting
|
||||
### 1. Chat Interattiva (Agent AI)
|
||||
|
||||
### "Module not found"
|
||||
```bash
|
||||
source venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
langcode
|
||||
# oppure
|
||||
langcode chat
|
||||
```
|
||||
|
||||
### Ollama non risponde
|
||||
Chatta con l'agent AI in tempo reale.
|
||||
|
||||
### 2. Server Web (API + Dashboard)
|
||||
|
||||
```bash
|
||||
# Verifica che Ollama sia attivo
|
||||
curl http://192.168.0.50:11434/api/tags
|
||||
langcode server
|
||||
langcode server --port 8080
|
||||
langcode server --host 0.0.0.0 --port 3000
|
||||
```
|
||||
|
||||
### cambia provider
|
||||
Accesso dopo l'avvio:
|
||||
- 🌐 **Web UI**: http://localhost:8000
|
||||
- 📊 **Dashboard**: http://localhost:8000/monitoring
|
||||
- 🛒 **Marketplace**: http://localhost:8000/marketplace
|
||||
- 📖 **API Docs**: http://localhost:8000/docs
|
||||
|
||||
### 3. CLI Configurazione
|
||||
|
||||
```bash
|
||||
export MODEL_PROVIDER=openai
|
||||
export MODEL_NAME=gpt-4o
|
||||
export OPENAI_API_KEY=sk-tuakey
|
||||
langcode config list # Lista configurazioni
|
||||
langcode config add -n nome -p ollama -m gemma2:9b -u http://... # Aggiungi
|
||||
langcode config use nome # Attiva configurazione
|
||||
langcode config active # Mostra attiva
|
||||
langcode config test # Testa connessione
|
||||
langcode config search ollama # Cerca
|
||||
langcode config export -f json # Esporta
|
||||
langcode config import backup.json # Importa
|
||||
```
|
||||
|
||||
## Struttura Base
|
||||
### 4. TUI Interattiva
|
||||
|
||||
```bash
|
||||
langcode tui
|
||||
```
|
||||
|
||||
Interfaccia testuale per gestire configurazioni.
|
||||
|
||||
### 5. Analytics
|
||||
|
||||
```bash
|
||||
langcode analytics # Riepilogo rapido
|
||||
langcode analytics --report # Report completo
|
||||
langcode dashboard # Dashboard performance
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Comandi Interni (nella Chat)
|
||||
|
||||
Durante la chat interattiva (`langcode chat`):
|
||||
|
||||
```
|
||||
/help # Aiuto
|
||||
/status # Stato sistema
|
||||
/config list # Lista configurazioni
|
||||
/config use <nome> # Cambia configurazione
|
||||
/models # Elenca modelli
|
||||
/clear # Pulisci schermo
|
||||
/exit # Esci
|
||||
```
|
||||
|
||||
### Memory (Memoria Persistente)
|
||||
|
||||
```
|
||||
/memory remember <testo> # Salva un fatto
|
||||
/memory recall <query> # Cerca fatti
|
||||
/memory preference set <key> <value> # Imposta preferenza
|
||||
/memory preference get <key> # Leggi preferenza
|
||||
/memory stats # Statistiche
|
||||
```
|
||||
|
||||
### Planning (Pianificazione)
|
||||
|
||||
```
|
||||
/plan create "<nome piano>" "<task1; task2; task3>" # Crea piano
|
||||
/plan list # Elenca piani
|
||||
/plan progress <plan_id> # Mostra progresso
|
||||
/plan start <task_id> # Inizia task
|
||||
/plan complete <task_id> # Completa task
|
||||
```
|
||||
|
||||
### Skills (Gestione Skills)
|
||||
|
||||
```
|
||||
/skills list # Skills installate
|
||||
/skills search <query> # Cerca skills
|
||||
/skills install <nome> # Installa skill
|
||||
/skills details <nome> # Dettagli skill
|
||||
/skills uninstall <nome> # Disinstalla
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Struttura
|
||||
|
||||
```
|
||||
langcode_agent/
|
||||
├── langcode.py # CLI entry point
|
||||
├── langcode.py # CLI unificato (langcode)
|
||||
├── main.py # Agent principale
|
||||
├── api_server.py # Server web + API
|
||||
├── config_manager.py # Gestione configurazioni
|
||||
├── config_cli.py # CLI configurazione
|
||||
├── config_tui.py # TUI configurazione
|
||||
├── skill_manager.py # Gestione skills
|
||||
├── mcp_client.py # Client MCP
|
||||
├── analytics.py # Analytics
|
||||
├── dashboard.py # Dashboard performance
|
||||
├── monitoring.py # Monitoraggio
|
||||
├── enhancements/ # Memory e Planning
|
||||
│ ├── simple_memory.py
|
||||
│ └── planning_enhancement.py
|
||||
├── web/ # Frontend web
|
||||
├── plugins/ # Plugin sistema
|
||||
└── venv/ # Virtual environment
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Tempo stimato**: ~5 minuti dall'inizio all'agent funzionante.
|
||||
## Provider Supportati
|
||||
|
||||
| Provider | Variabili necessarie |
|
||||
|-------------|---------------------|
|
||||
| Ollama | `OLLAMA_BASE_URL` |
|
||||
| OpenAI | `OPENAI_API_KEY` |
|
||||
| OpenRouter | `OPENROUTER_API_KEY` |
|
||||
| Anthropic | `ANTHROPIC_API_KEY` |
|
||||
| Google | `GOOGLE_API_KEY` |
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Agent non si avvia:**
|
||||
```bash
|
||||
source venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
**Ollama non risponde:**
|
||||
```bash
|
||||
curl http://192.168.0.50:11434/api/tags
|
||||
```
|
||||
|
||||
**Porta già in uso:**
|
||||
```bash
|
||||
langcode server --port 8080
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Tempo installazione**: ~5 minuti
|
||||
Reference in new issue
Block a user