Merge pull request #1 from Joshua92500/dev

Update v0.1.0

Author: Joshua92500

.gitignore

@@ -1,8 +1,10 @@
-# Ignore local Python environment
+# Ignore local development environment
 __pycache__/
 *.pyc
 .venv/
 *.egg-info/
+*.fish
+*.sh
 
 
 # Ignore custom companions and prompts

README.md

@@ -1 +1,127 @@
-# sodalis
+# Sodalis
+
+A local AI companion and system assistant powered by [Ollama](https://ollama.com). Run a fully offline, customizable AI from your terminal.
+
+---
+
+## Features
+
+- **CLI-first** — send messages directly from your terminal
+- **Companion profiles** — swap between different AI personas via YAML config
+- **Custom system prompts** — define your companion's behavior with plain text files
+- **Ollama backend** — runs models locally via the Ollama API
+
+---
+
+## Requirements
+
+- Python 3.11+
+- [Ollama](https://ollama.com) running locally (or via Docker)
+- An Ollama-compatible model pulled
+
+---
+
+## Installation
+
+```bash
+git clone https://github.com/Joshua92500/sodalis.git
+cd sodalis
+pip install -e .
+```
+
+This installs the `sodalis` CLI command.
+
+---
+
+## Running Ollama
+
+You can run Ollama locally, or use the included Docker Compose file (requires NVIDIA GPU):
+
+```bash
+docker compose up -d
+```
+
+Then pull a model:
+
+```bash
+docker exec -it sodalis-ollama ollama pull qwen3:8b
+```
+
+---
+
+## Configuration
+
+Sodalis looks for companion profiles and system prompts in `~/.config/sodalis/`.
+
+Copy the defaults to get started:
+
+```bash
+mkdir -p ~/.config/sodalis/companions ~/.config/sodalis/prompts
+cp config/companions/default.yaml ~/.config/sodalis/companions/
+cp config/prompts/system_prompt.txt ~/.config/sodalis/prompts/
+```
+
+### Companion profile (`companions/default.yaml`)
+
+```yaml
+name: Default
+model: qwen3:8b
+system_prompt: system_prompt.txt
+temperature: 0.7
+```
+
+| Field | Description |
+|---|---|
+| `name` | Display name for the companion |
+| `model` | Ollama model to use |
+| `system_prompt` | Filename of the system prompt in `~/.config/sodalis/prompts/` |
+| `temperature` | Sampling temperature (0.0–1.0) |
+
+### System prompt (`prompts/system_prompt.txt`)
+
+Plain text file that sets the personality and behavior of the companion.
+
+---
+
+## Usage
+
+```bash
+sodalis --chat
+```
+
+Use a specific companion profile:
+
+```bash
+sodalis --chat --companion="MyCompanion"
+```
+
+---
+
+## Project Structure
+
+```
+sodalis/
+├── config/
+│   ├── companions/       # Default companion profiles
+│   └── prompts/          # Default system prompts
+├── src/sodalis/
+│   ├── cli.py            # Entry point and argument parsing
+│   ├── config.py         # Companion config loader
+│   ├── db.py             # SQLite database client
+│   ├── history.py        # Chat history handling
+│   ├── llm.py            # Ollama API client
+│   └── paths.py          # XDG-style path helpers
+├── docker-compose.yml    # Ollama service with GPU support
+└── pyproject.toml        # Project metadata and dependencies
+```
+
+---
+
+## Runtime Directories
+
+Sodalis follows XDG conventions:
+
+| Purpose | Path |
+|---|---|
+| Config & companions | `~/.config/sodalis/` |
+| Data (memory DB) | `~/.local/share/sodalis/` |

config/companions/default.yaml

@@ -2,3 +2,9 @@ name: Default
 model: qwen3:8b
 system_prompt: system_prompt.txt
 temperature: 0.7
+
+tools:
+  enabled: true
+  timeout: 10
+  max_output: 4096
+  max_rounds: 3

config/prompts/system_prompt.txt

@@ -1 +1,2 @@
-You are Sodalis, a local AI companion running on a Linux machine. Be practical, concise, and clear.
+You are a local AI companion running on a Linux machine. Be practical, concise, and clear.
+You can run read-only Linux commands when needed to answer questions. Use the tool format described below when you need to inspect the system.

src/sodalis/cli.py

@@ -2,48 +2,213 @@
 
 from sodalis.config import load_companion_config
 from sodalis.paths import ensure_runtime_dirs, get_prompts_dir
-from sodalis.llm import generate_response
+from sodalis.llm import generate_response, generate_with_tools
+from sodalis.db import init_db
+from sodalis.history import create_chat, delete_chat, list_chats, chat_exists, load_messages, save_message
+from sodalis.prompt_builder import build_prompt, load_prompt_layers
+from sodalis.tools import TOOL_SCHEMA_TEXT
 
 
-def load_system_prompt(filename: str) -> str:
-    prompt_path = get_prompts_dir() / filename
+def run_chat(companion, system_prompt, companion_prompt, chat_id = None, resume_chat_id = None, use_tools = True):
+    print(f"Sodalis {companion['name']} ({companion['model']})")
+    
+    tools_cfg = companion.get("tools", {})
+    
+    history = []
+    chat_id = None
 
-    if not prompt_path.exists():
-        raise FileNotFoundError(f"System prompt not found: {prompt_path}")
+    if resume_chat_id is not None:
+        if not chat_exists(resume_chat_id):
+            print(f"Chat {resume_chat_id} not found.")
+            return
 
-    return prompt_path.read_text(encoding="utf-8").strip()
+        chat_id = resume_chat_id
+        messages = load_messages(chat_id)
+        history = db_messages_to_prompt_history(messages)
+
+        print(f"Resuming chat {chat_id}.")
+
+    while True:
+        try:
+            user_input = input("> ").strip()
+
+            if user_input.lower() in {"exit", "quit"}:
+                print("Goodbye.")
+                break
+
+            if not user_input:
+                continue
+
+            if chat_id is None:
+                chat_id = create_chat(
+                        companion=companion["name"],
+                        model=companion["model"],
+                )
+            save_message(chat_id, "user", user_input)
+
+            prompt = build_prompt(system_prompt, companion_prompt, history, user_input)
+
+            if use_tools and tools_cfg.get("enabled", True):
+                response = generate_with_tools(
+                    prompt,
+                    companion["model"],
+                    companion["temperature"],
+                    max_rounds=tools_cfg.get("max_rounds", 3),
+                    timeout=tools_cfg.get("timeout", 10),
+                    max_output=tools_cfg.get("max_output", 4096),
+                )
+            else:
+                response = generate_response(
+                    prompt, 
+                    companion["model"], 
+                    companion["temperature"]
+                )
+
+            print(response)
+
+            save_message(chat_id, "assistant", response)
+
+            history.append({"role": "user", "content": user_input})
+            history.append({"role": "assistant", "content": response})
+
+        except KeyboardInterrupt:
+            print("\nExiting.")
+            break
+
+
+def run_once(companion, system_prompt, message, use_tools=True):
+
+    tools_cfg = companion.get("tools", {})
+    full_prompt = f"{system_prompt}\n\nUSER: {message}\nASSISTANT:"
+
+    if use_tools and tools_cfg.get("enabled", True):
+        response = generate_with_tools(
+            prompt=full_prompt,
+            model=companion["model"],
+            temperature=companion["temperature"],
+            max_rounds=tools_cfg.get("max_rounds", 3),
+            timeout=tools_cfg.get("timeout", 10),
+            max_output=tools_cfg.get("max_output", 4096),
+        )
+    else:
+        response = generate_response(
+            prompt=full_prompt,
+            model=companion["model"],
+            temperature=companion["temperature"],
+        )
+
+    print(response)
+
+
+def print_history_table(chats):
+    if not chats:
+        print("No saved chats found.")
+        return
+
+    print(f"{'ID':<6} {'MODEL':<15} {'TITLE':<50} {'CREATED'}")
+    print("-" * 95)
+
+    for chat_id, model, title, created_at in chats:
+        title = (title or "")[:50]
+        print(f"{chat_id:<6} {model:<15} {title:<50} {created_at}")
+
+
+def confirm_delete(chat_id: int) -> bool:
+    answer = input(f"Are you sure you want to delete chat {chat_id}? [y/N]: ").strip().lower()
+    return answer in {"y", "yes"}
+
+
+def db_messages_to_prompt_history(messages: tuple):
+    history = []
+
+    for role, content in messages:
+        if role == "user":
+            prompt_role = "USER"
+        elif role == "assistant":
+            prompt_role = "ASSISTANT"
+        else:
+            continue
+
+        history.append({"role": prompt_role, "content": content})
+
+    return history
 
 
 def main() -> None:
+    init_db()
+
     parser = argparse.ArgumentParser(prog="sodalis")
     parser.add_argument(
             "message",
+            nargs="?",
             help="Message to send to the companion",
             )
     parser.add_argument(
             "--companion",
             default="default",
             help="Name of the companion profile to load",
             )
-    args = parser.parse_args()
+    parser.add_argument(
+            "--chat",
+            nargs="?",
+            const="new",
+            metavar="CHAT_ID",
+            help="Start a new chat or resume an exisitng chat by ID"
+            )
+    parser.add_argument(
+            "--history",
+            action="store_true",
+            help="Show saved chat history",
+            )
+    parser.add_argument(
+            "--delete",
+            type=int,
+            metavar="CHAT_ID",
+            help="Delete a saved chat by ID",
+            )
+    parser.add_argument(
+            "--no-tools",
+            action="store_true",
+            help="Disable tool use for this invocation",
+            )
 
+    args = parser.parse_args()
     ensure_runtime_dirs()
+    
+    companion = load_companion_config(args.companion)
+    companion_name = companion.get("name", args.companion)
+    system_prompt, companion_prompt = load_prompt_layers(companion)
 
-    config = load_companion_config(args.companion)
-    companion_name = config.get("name", args.companion)
+    use_tools = not args.no_tools
+    tools_cfg = companion.get("tools", {})
+    if use_tools and tools_cfg.get("enabled", True):
+        system_prompt = system_prompt + "\n\n" + TOOL_SCHEMA_TEXT
+    
+    if args.history:
+        chats = list_chats()
+        print_history_table(chats)
+        return
+    
+    if args.delete is not None:
+        if not confirm_delete(args.delete):
+            print("Delete cancelled.")
+            return
 
-    system_prompt = load_system_prompt(config["system_prompt"])
+        deleted = delete_chat(args.delete)
 
-    full_prompt = f"{system_prompt}\n\nUser: {args.message}\nAssistant:"
+        if deleted:
+            print(f"Chat {args.delete} deleted.")
+        else:
+            print(f"Chat {args.delete} not found.")
 
-    response = generate_response(
-            prompt=full_prompt,
-            model=config["model"],
-            temperature=config["temperature"],
-            )
-
-    print(response)
+        return
 
+    if args.chat is not None:
+        if args.chat == "new":
+            run_chat(companion, system_prompt, companion_prompt, use_tools=use_tools)
+        else:
+            run_chat(companion, system_prompt, companion_prompt, resume_chat_id=int(args.chat), use_tools=use_tools)
+    
 
 if __name__ == "__main__":
     main()

src/sodalis/config.py

@@ -24,7 +24,7 @@ def load_companion_config(name: str = "default") -> dict:
         raise ValueError(f"Invalid companion config in {config_path}: top-level YAML must be a mapping")
 
     # YAML validation
-    required_fields = ["name", "model", "system_prompt", "temperature"]
+    required_fields = ["name", "model", "companion_prompt", "temperature"]
     for field in required_fields:
         if field not in data:
             raise ValueError(f"Missing required field '{field}' in {config_path}")