RomanNum3ral
/
cai
mirror of https://github.com/aliasrobotics/cai.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

messages .env file

This commit is contained in:
SoyGema 2025-09-16 12:06:09 +02:00
parent a065d4ffab
commit 9cefc9fe23
2 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -385,6 +385,8 @@ cai
CAI leverages the `.env` file to load configuration at launch. To facilitate the setup, the repo provides an exemplary [`.env.example`](.env.example) file provides a template for configuring CAI's setup and your LLM API keys to work with desired LLM models.
**File Location:** CAI looks for the `.env` file in the current directory where you execute the command, and if it doesn't find it, it searches upward in the directory hierarchy. Since you run CAI from some subdirectory of `/Users/me/Documents/`, it finds the file `/Users/me/Documents/.env`. The virtual environment only contains the installed Python packages, not application configurations like `.env` files.
:warning: Important:
CAI does NOT provide API keys for any model by default. Don't ask us to provide keys, use your own or host your own models.
@ -704,6 +706,8 @@ From here on, type on `CAI` and start your security exercise. Best way to learn
### Environment Variables
For using private models, you are given a [`.env.example`](.env.example) file. Copy it and rename it as `.env`. Fill in your corresponding API keys, and you are ready to use CAI.
**File Location:** CAI looks for the `.env` file in the current directory where you execute the command. If you run CAI from some subdirectory of `/Users/me/Documents/`, it finds the file `/Users/me/Documents/.env`. The virtual environment only contains the installed Python packages, not application configurations like `.env` files.
<details>
<summary>List of Environment Variables</summary>
@ -875,6 +879,14 @@ See the following issues that treat this topic in more detail:
</details>
<details><summary>Where does CAI look for the .env file?</summary>
CAI looks for the .env file in the current directory where you execute the command. If you run CAI from some subdirectory of /Users/me/Documents/, it finds the file /Users/me/Documents/.env
The virtual environment only contains the installed Python packages, not application configurations like .env files.
</details>
<details><summary>Where are all the caiextensions?</summary>
See [all caiextensions](https://gitlab.com/aliasrobotics/alias_research/caiextensions)

2
docs/cai_installation.md
View File

@ -134,6 +134,8 @@ cai
CAI leverages the `.env` file to load configuration at launch. To facilitate the setup, the repo provides an exemplary `.env.example` file provides a template for configuring CAI's setup and your LLM API keys to work with desired LLM models.
**File Location:** CAI looks for the `.env` file in the current directory where you execute the command. If you run CAI from some subdirectory of `/Users/me/Documents/`, it finds the file `/Users/me/Documents/.env`. The virtual environment only contains the installed Python packages, not application configurations like `.env` files.
```bash
OPENAI_API_KEY="sk-1234"
# OPENAI_API_KEY MUST BE FILLED-IN.