This commit is contained in:
lidia9 2025-05-14 11:56:27 +02:00
parent 38c0d3c9cc
commit 00671adacd
4 changed files with 46 additions and 11 deletions

View File

@ -63,9 +63,10 @@ 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
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
From Powershell write: ` wsl --install`
```bash
sudo apt-get update && \
@ -125,4 +126,18 @@ cp .env.example .env # edit here your keys/models
# Launch CAI
cai
```
```
### Custom OpenAI Base URL Support
CAI supports configuring a custom OpenAI API base URL via the `OPENAI_BASE_URL` environment variable. This allows users to redirect API calls to a custom endpoint, such as a proxy or self-hosted OpenAI-compatible service.
Example `.env` entry configuration:
```
OLLAMA_API_BASE="https://custom-openai-proxy.com/v1"
```
Or directly from the command line:
```bash
OLLAMA_API_BASE="https://custom-openai-proxy.com/v1" cai
```

View File

@ -145,7 +145,20 @@ ANTHROPIC_API_KEY=""
OLLAMA=""
PROMPT_TOOLKIT_NO_CPR=1
```
⚠️ CAI does NOT provide API keys for any model by default.
### Custom OpenAI Base URL Support
```
CAI supports configuring a custom OpenAI API base URL via the `OPENAI_BASE_URL` environment variable. This allows users to redirect API calls to a custom endpoint, such as a proxy or self-hosted OpenAI-compatible service.
Example `.env` entry configuration:
```
OLLAMA_API_BASE="https://custom-openai-proxy.com/v1"
```
Or directly from the command line:
```bash
OLLAMA_API_BASE="https://custom-openai-proxy.com/v1" cai
```

View File

@ -58,7 +58,9 @@ From here on, type on `CAI` and start your security exercise. Best way to learn
There are several ways to configure environment variables for CAI:
1. **Using the `.env` file**:
---
### 1. Using the `.env` file
```
# Add any env variable to your .env file
@ -66,13 +68,17 @@ CAI_PRICE_LIMIT="0.004"
CAI_MODEL="qwen2.5:72b"
```
2. **Command-line parameters**: Pass variables directly when launching CAI
### 2. Command-line parameters
Pass variables directly when launching CAI
```
CAI_PRICE_LIMIT="0.004" CAI_MODEL="qwen2.5:72b" cai
```
3. **Runtime configuration**: after running CAI, use `/config`
### 3. Runtime configuration
After running CAI, use `/config`
```
/config set <number> <value> to configure a variable # see `config.py` or type `/help`
@ -85,4 +91,4 @@ CAI_PRICE_LIMIT="0.004" CAI_MODEL="qwen2.5:72b" cai
# You must pick its reference NUMBER (1st column left)
# `18` is the corresponding number for CAI_PRICE_LIMIT
/config set 18 "0.004"
```
```

View File

@ -30,12 +30,13 @@ nav:
#- Quickstart: quickstart.md
#- Examples: examples.md
- Documentation:
- agents.md #
- agents.md
- running_agents.md
- results.md
- streaming.md
- tools.md
- mcp.md
#- mcp.md
#- cai_mcp.md
- handoffs.md
- tracing_cai.md
- context.md