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 1/4] 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`.

From ed901836449cdcfadd0d91be4e4988ed679a2522 Mon Sep 17 00:00:00 2001
From: Francesco Balassone <77972200+duel0@users.noreply.github.com>
Date: Mon, 9 Jun 2025 10:06:15 +0200
Subject: [PATCH 2/4] Create CITATION.cff (#192)

Adding a CITATION.cff file helps users to easily cite software from the repository overview.
---
 CITATION.cff | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 CITATION.cff

diff --git a/CITATION.cff b/CITATION.cff
new file mode 100644
index 00000000..746c800e
--- /dev/null
+++ b/CITATION.cff
@@ -0,0 +1,9 @@
+@misc{mayoralvilches2025caiopenbugbountyready,
+      title={CAI: An Open, Bug Bounty-Ready Cybersecurity AI},
+      author={Víctor Mayoral-Vilches and Luis Javier Navarrete-Lozano and María Sanz-Gómez and Lidia Salas Espejo and Martiño Crespo-Álvarez and Francisco Oca-Gonzalez and Francesco Balassone and Alfonso Glera-Picón and Unai Ayucar-Carbajo and Jon Ander Ruiz-Alcalde and Stefan Rass and Martin Pinzger and Endika Gil-Uriarte},
+      year={2025},
+      eprint={2504.06017},
+      archivePrefix={arXiv},
+      primaryClass={cs.CR},
+      url={https://arxiv.org/abs/2504.06017},
+}

From b80b898941ebe5da9d2b42200f828010cf376996 Mon Sep 17 00:00:00 2001
From: Kaarel Kaarelson <kaarel.kaarelson@gmail.com>
Date: Mon, 9 Jun 2025 11:52:47 +0300
Subject: [PATCH 3/4] Add missing PyPDF2 package (#193)

Co-authored-by: Kaarel Kaarelson <kaarelkaarelson@Mac.lan>
---
 pyproject.toml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/pyproject.toml b/pyproject.toml
index 3a2eb50e..baad7be2 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -31,7 +31,8 @@ dependencies = [
     "mkdocs-material>=9.6.0",
     "paramiko>=3.5.1",
     "dnspython",
-    "flask"
+    "flask",
+    "PyPDF2,
 ]
 classifiers = [
     "Typing :: Typed",

From b7279172227f8e0ea90e919691d42f1cddbfa2e4 Mon Sep 17 00:00:00 2001
From: Kaarel Kaarelson <kaarel.kaarelson@gmail.com>
Date: Mon, 9 Jun 2025 15:55:44 +0300
Subject: [PATCH 4/4] Add missing PyPDF2 package fix (#194)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Add missing PyPDF2 package

* Fix the missing quotation

---------

Co-authored-by: Kaarel Kaarelson <kaarelkaarelson@Mac.lan>
Co-authored-by: Kaarel Kaarelson <kaarelkaarelson@Kaarels-MacBook-Air.local>
Co-authored-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
---
 pyproject.toml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pyproject.toml b/pyproject.toml
index baad7be2..ee75d30b 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -32,7 +32,7 @@ dependencies = [
     "paramiko>=3.5.1",
     "dnspython",
     "flask",
-    "PyPDF2,
+    "PyPDF2",
 ]
 classifiers = [
     "Typing :: Typed",