From bfa890430dc857674c05548751dda46500a16ce9 Mon Sep 17 00:00:00 2001
From: UnaiAlias <52742669+UnaiAlias@users.noreply.github.com>
Date: Fri, 6 Jun 2025 10:45:01 +0200
Subject: [PATCH] some extra bits to be able to use alias0 in CAI 0.4.0 (#189)

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 24056392..0b0e6394 100644
--- a/README.md
+++ b/README.md
@@ -146,6 +146,8 @@ Cybersecurity AI is a critical field, yet many groups are misguidedly pursuing i
 pip install cai-framework
 ```
 
+Always create a new virtual environment to ensure proper dependency installation when updating CAI.
+
 The following subsections provide a more detailed walkthrough on selected popular Operating Systems. Refer to the [Development](#development) section for developer-related install instructions.
 
 ### OS X
@@ -286,6 +288,16 @@ CAI does NOT provide API keys for any model by default. Don't ask us to provide
 
 The OPENAI_API_KEY must not be left blank. It should contain either "sk-123" (as a placeholder) or your actual API key. See https://github.com/aliasrobotics/cai/issues/27.
 
+:warning: Note:
+
+If you are using alias0 model, make sure that CAI is >0.4.0 version and here you have an .env example to be able to use it.
+
+```bash
+OPENAI_API_KEY="sk-1234"
+OLLAMA=""
+ALIAS_API_KEY="<sk-your-key>"  # note, add yours
+CAI_STEAM=False
+```
 
 ### 🔹 Custom OpenAI Base URL Support
 
@@ -301,6 +313,7 @@ Or directly from the command line:
 OLLAMA_API_BASE="https://custom-openai-proxy.com/v1" cai
 ```
 
+
 ## :triangular_ruler: Architecture:
 
 CAI focuses on making cybersecurity agent **coordination** and **execution** lightweight, highly controllable, and useful for humans. To do so it builds upon 7 pillars: `Agent`s, `Tools`, `Handoffs`, `Patterns`, `Turns`, `Tracing` and `HITL`.