Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

chore: add .env.example, ignore real env files, update README setup (#3147)

Lei Zhang230787144aaf
diff --git a/.env b/.env.example
similarity index 100%
rename from .env
rename to .env.example
diff --git a/.gitignore b/.gitignore
index 6aae8009d..04b5f097a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -432,8 +432,9 @@ benchmark/gaia/results.jsonl
# Secret files for docker
.container/.env
-# Environment variables file
-.env
+# Environment variables files (ignore real envs, keep examples)
+/.env*
+!/.env*.example
##### Node.js/TypeScript.gitignore #####
# Hybrid Browser Toolkit TypeScript
@@ -462,4 +463,4 @@ yarn-error.log*
*.tgz
# Yarn Integrity file
-.yarn-integrity
\ No newline at end of file
+.yarn-integrity
diff --git a/README.md b/README.md
index 87bb879fc..a11359326 100644
--- a/README.md
+++ b/README.md
@@ -246,6 +246,13 @@ This example demonstrates how to create a `ChatAgent` using the CAMEL framework
export OPENAI_API_KEY='your_openai_api_key'
```
+ Alternatively, use a `.env` file:
+
+ ```bash
+ cp .env.example .env
+ # then edit .env and add your keys
+ ```
+
3. **Run the following Python code:**
```python
@@ -608,4 +615,4 @@ The source code is licensed under Apache 2.0.
[reddit-url]: https://www.reddit.com/r/CamelAI/
[reddit-image]: https://img.shields.io/reddit/subreddit-subscribers/CamelAI?style=plastic&logo=reddit&label=r%2FCAMEL&labelColor=white
[ambassador-url]: https://www.camel-ai.org/community
-[package-download-url]: https://pypi.org/project/camel-ai
\ No newline at end of file
+[package-download-url]: https://pypi.org/project/camel-ai