From 054f3038de4a19148534bed55fad754bd7c8c4e8 Mon Sep 17 00:00:00 2001 From: RMtz88 <64791779+RMtz88@users.noreply.github.com> Date: Thu, 6 Nov 2025 06:03:09 +0100 Subject: [PATCH] Add installation guides in Markdown format for CAI Pro v0.5 and v0.6 (#312) * Add installation guides in Markdown format for CAI Pro v0.5 and v0.6 * Add references to CAI Pro installation guides in README Install section * Add Homebrew installation step for OS X in CAI Pro v0.5 guide * Add navigation links back to README Install section in CAI Pro guides --------- Co-authored-by: Rufino Cabrera --- README.md | 7 + docs/Installation_Guide_for_CAI_Pro_v0.5.md | 139 +++++++++++++++++++ docs/Installation_Guide_for_CAI_Pro_v0.6.md | 141 ++++++++++++++++++++ 3 files changed, 287 insertions(+) create mode 100644 docs/Installation_Guide_for_CAI_Pro_v0.5.md create mode 100644 docs/Installation_Guide_for_CAI_Pro_v0.6.md diff --git a/README.md b/README.md index 7eb69f96..c812f3cc 100644 --- a/README.md +++ b/README.md @@ -338,6 +338,13 @@ Cybersecurity AI is a critical field, yet many groups are misguidedly pursuing i ## :nut_and_bolt: Install +> [!NOTE] +> **CAI Professional Edition Users**: If you have an active CAI Pro subscription, we provide dedicated installation guides for versions 0.5 and 0.6. Official support is available for Ubuntu 24.04 (x86_64). Installation instructions for other operating systems are provided as-is without official support: +> - [CAI Pro v0.6 Installation Guide](docs/Installation_Guide_for_CAI_Pro_v0.6.md) +> - [CAI Pro v0.5 Installation Guide](docs/Installation_Guide_for_CAI_Pro_v0.5.md) + +### Community Edition Installation + ```bash pip install cai-framework ``` diff --git a/docs/Installation_Guide_for_CAI_Pro_v0.5.md b/docs/Installation_Guide_for_CAI_Pro_v0.5.md new file mode 100644 index 00000000..8a979de5 --- /dev/null +++ b/docs/Installation_Guide_for_CAI_Pro_v0.5.md @@ -0,0 +1,139 @@ +# Installation Guide for CAI Pro v0.5 + +← [Back to Installation Guide](../README.md#nut_and_bolt-install) + +## Welcome to CAI Pro! + +If your subscription is active, you have received a confirmation email. Then, get and save your API-Key and please follow these instructions to install CAI Pro on your system. + +### Important + +- Your API Key is personal and non-transferable. +- It will be permanently linked to the first system where it is used. + +## System Requirements + +- OS: Ubuntu 24.04 (x86_64, 64-bit) +- Language: English +- Python: 3.8+ (installed automatically) +- Memory: Minimum 4 GB RAM + +## Installation Steps + +- Download the installer file we provided in the Confirmation to your CAI-Pro subscription: `cai-pro_Linux.deb` +- Open a terminal in your Downloads directory. +- Run the following commands: + - `sudo apt update` + - `sudo apt install ./cai-pro_Linux.deb` +- During installation, follow the instructions and you will be asked to provide your API Key: `sk--xxxxxxxxxxxxxxxx` +- Once completed, CAI will start automatically. + +## Accessing CAI + +- Desktop Icon → double-click on "CAI (by Alias Robotics)" +- Application Menu → search for "CAI" +- Command Line → run: `cai` + +## Support + +If you encounter any issues, contact us at: contact@aliasrobotics.com + +Although we do not provide official support for other operating systems, we offer the recommended installation steps below. + +## Installation Steps for Other OS + +### OS X + +```bash +# Install homebrew +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" + +# Install dependencies +brew update && \ +brew install git python@3.12 + +# Create virtual environment +python3.12 -m venv cai_env + +# Install the package from the local directory +source cai_env/bin/activate && pip install cai-framework + +# Generate a .env file and set up with defaults +echo -e 'OPENAI_API_KEY="sk-1234"\nANTHROPIC_API_KEY=""\nOLLAMA=""\nPROMPT_TOOLKIT_NO_CPR=1\nCAI_STREAM=false' > .env + +# Launch CAI +cai # first launch it can take up to 30 seconds +``` + +### Windows WSL + +Go to the Microsoft page: https://learn.microsoft.com/en-us/windows/wsl/install + +Here you will find all the instructions to install WSL. From Powershell write: `wsl --install` + +```bash +sudo apt-get update && \ +sudo apt-get install -y git python3-pip python3-venv + +# Create the virtual environment +python3 -m venv cai_env + +# Install the package from the local directory +source cai_env/bin/activate && pip install cai-framework + +# Generate a .env file and set up with defaults +echo -e 'OPENAI_API_KEY="sk-1234"\nANTHROPIC_API_KEY=""\nOLLAMA=""\nPROMPT_TOOLKIT_NO_CPR=1\nCAI_STREAM=false' > .env + +# Launch CAI +cai # first launch it can take up to 30 seconds +``` + +### Android + +We recommend having at least 8 GB of RAM: + +1. First of all, install userland: https://play.google.com/store/apps/details?id=tech.ula&hl=es +2. Install Kali minimal in basic options (for free). [Or any other kali option if preferred] +3. Update apt keys like in this example: https://superuser.com/questions/1644520/apt-get-update-issue-in-kali, inside UserLand's Kali terminal execute: + +```bash +# Get new apt keys +wget http://http.kali.org/kali/pool/main/k/kali-archive-keyring/kali-archive-keyring_2024.1_all.deb + +# Install new apt keys +sudo dpkg -i kali-archive-keyring_2024.1_all.deb && rm kali-archive-keyring_2024.1_all.deb + +# Update APT repository +sudo apt-get update + +# CAI requires python 3.12, lets install it (CAI for kali in Android) +sudo apt-get update && sudo apt-get install -y git python3-pip build-essential zlib1g-dev \ +libncurses5-dev libgdbm-dev libnss3-dev libssl-dev libreadline-dev libffi-dev libsqlite3-dev \ +wget libbz2-dev pkg-config + +wget https://www.python.org/ftp/python/3.12.4/Python-3.12.4.tar.xz +tar xf Python-3.12.4.tar.xz +cd Python-3.12.4 +./configure --enable-optimizations +sudo make altinstall # This command takes long to execute + +# Clone CAI's source code +git clone https://github.com/aliasrobotics/cai && cd cai + +# Create virtual environment +python3.12 -m venv cai_env + +# Install the package from the local directory +source cai_env/bin/activate && pip3 install -e . + +# Generate a .env file and set up +cp .env.example .env # edit here your keys/models + +# Launch CAI +cai +``` + +--- + +**[⬅️ Return to Main Installation Guide](../README.md#nut_and_bolt-install)** + diff --git a/docs/Installation_Guide_for_CAI_Pro_v0.6.md b/docs/Installation_Guide_for_CAI_Pro_v0.6.md new file mode 100644 index 00000000..f7bc4e3b --- /dev/null +++ b/docs/Installation_Guide_for_CAI_Pro_v0.6.md @@ -0,0 +1,141 @@ +# Installation Guide for CAI Pro v0.6 + +← [Back to Installation Guide](../README.md#nut_and_bolt-install) + +## Welcome to CAI Pro! + +If your subscription is active, you have received a confirmation email. Then, get and save your API-Key and please follow these instructions to install CAI Pro on your system. + +### Important + +- Your API Key is personal and non-transferable. +- It will be permanently linked to the first system where it is used. + +## System Requirements + +- OS: Ubuntu 24.04 (x86_64, 64-bit) +- Language: English +- Python: 3.8+ (installed automatically) +- Memory: Minimum 4 GB RAM + +## Installation Steps + +- Create a folder in your preferred directory. +- Open a terminal in that directory. +- Create a virtual environment, activate it, and install CAI Pro with the following commands: + - `sudo apt update` + - `python3.12 -m venv cai_env` + - `source cai_env/bin/activate` + - `pip install --index-url https://packages.aliasrobotics.com:664// cai-framework` +- Important note: + - The last command requires customization. Replace `` with the API Key provided in the confirmation email for your subscription, for example: `sk--xxxxxxxxxxxxxxxx` +- Once the installation is complete, run: + - `cai –tui` + +## Accessing CAI + +- Command Line → run: `cai –tui` + +## Support + +If you encounter any issues, contact us at: contact@aliasrobotics.com + +Although we do not provide official support for other operating systems, we offer the recommended installation steps below. + +## Installation Steps for Other OS + +### OS X + +```bash +# Install homebrew +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" + +# Install dependencies +brew update && \ +brew install git python@3.12 + +# Create virtual environment +python3.12 -m venv cai_env + +# Install the package from the local directory +source cai_env/bin/activate && pip install cai-framework + +# Generate a .env file and set up with defaults +echo -e 'OPENAI_API_KEY="sk-1234"\nANTHROPIC_API_KEY=""\nOLLAMA=""\nPROMPT_TOOLKIT_NO_CPR=1\nCAI_STREAM=false' > .env + +# Launch CAI +cai # first launch it can take up to 30 seconds +``` + +### Windows WSL + +Go to the Microsoft page: https://learn.microsoft.com/en-us/windows/wsl/install + +Here you will find all the instructions to install WSL. From Powershell write: `wsl --install` + +```bash +sudo apt-get update && \ +sudo apt-get install -y git python3-pip python3-venv + +# Create the virtual environment +python3 -m venv cai_env + +# Install the package from the local directory +source cai_env/bin/activate && pip install cai-framework + +# Generate a .env file and set up with defaults +echo -e 'OPENAI_API_KEY="sk-1234"\nANTHROPIC_API_KEY=""\nOLLAMA=""\nPROMPT_TOOLKIT_NO_CPR=1\nCAI_STREAM=false' > .env + +# Launch CAI +cai # first launch it can take up to 30 seconds +``` + +### Android + +We recommend having at least 8 GB of RAM: + +1. First of all, install userland: https://play.google.com/store/apps/details?id=tech.ula&hl=es +2. Install Kali minimal in basic options (for free). [Or any other kali option if preferred] +3. Update apt keys like in this example: https://superuser.com/questions/1644520/apt-get-update-issue-in-kali, inside UserLand's Kali terminal execute: + +```bash +# Get new apt keys +wget http://http.kali.org/kali/pool/main/k/kali-archive-keyring/kali-archive-keyring_2024.1_all.deb + +# Install new apt keys +sudo dpkg -i kali-archive-keyring_2024.1_all.deb && rm kali-archive-keyring_2024.1_all.deb + +# Update APT repository +sudo apt-get update + +# CAI requires python 3.12, lets install it (CAI for kali in Android) +sudo apt-get update && sudo apt-get install -y git python3-pip build-essential zlib1g-dev \ +libncurses5-dev libgdbm-dev libnss3-dev libssl-dev libreadline-dev libffi-dev libsqlite3-dev \ +wget libbz2-dev pkg-config + +wget https://www.python.org/ftp/python/3.12.4/Python-3.12.4.tar.xz +tar xf Python-3.12.4.tar.xz +cd Python-3.12.4 +./configure --enable-optimizations +sudo make altinstall # This command takes long to execute + +# Clone CAI's source code +git clone https://github.com/aliasrobotics/cai && cd cai + +# Create virtual environment +python3.12 -m venv cai_env + +# Install the package from the local directory +source cai_env/bin/activate && pip3 install -e . + +# Generate a .env file and set up +cp .env.example .env # edit here your keys/models + +# Launch CAI +cai +``` + +--- + +**[⬅️ Return to Main Installation Guide](../README.md#nut_and_bolt-install)** +