diff --git a/samples/agent/adk/contact_lookup/.env.example b/samples/agent/adk/contact_lookup/.env.example new file mode 100644 index 00000000..c4522b4e --- /dev/null +++ b/samples/agent/adk/contact_lookup/.env.example @@ -0,0 +1,7 @@ +# Copy this file to .env and fill in your API key +# Get your API key at: https://aistudio.google.com/apikey + +GEMINI_API_KEY=your_gemini_api_key_here + +# Optional: Use Vertex AI instead of Gemini API +# GOOGLE_GENAI_USE_VERTEXAI=TRUE diff --git a/samples/agent/adk/contact_lookup/README.md b/samples/agent/adk/contact_lookup/README.md index 976d6200..bf0ab276 100644 --- a/samples/agent/adk/contact_lookup/README.md +++ b/samples/agent/adk/contact_lookup/README.md @@ -19,7 +19,8 @@ This sample uses the Agent Development Kit (ADK) along with the A2A protocol to 2. Create an environment file with your API key: ```bash - echo "GEMINI_API_KEY=your_api_key_here" > .env + cp .env.example .env + # Edit .env with your actual API key (do not commit .env) ``` 3. Run the server: diff --git a/samples/agent/adk/orchestrator/.env.example b/samples/agent/adk/orchestrator/.env.example new file mode 100644 index 00000000..c4522b4e --- /dev/null +++ b/samples/agent/adk/orchestrator/.env.example @@ -0,0 +1,7 @@ +# Copy this file to .env and fill in your API key +# Get your API key at: https://aistudio.google.com/apikey + +GEMINI_API_KEY=your_gemini_api_key_here + +# Optional: Use Vertex AI instead of Gemini API +# GOOGLE_GENAI_USE_VERTEXAI=TRUE diff --git a/samples/agent/adk/orchestrator/README.md b/samples/agent/adk/orchestrator/README.md index 58cae833..23538c89 100644 --- a/samples/agent/adk/orchestrator/README.md +++ b/samples/agent/adk/orchestrator/README.md @@ -19,8 +19,8 @@ Subagents are configured using RemoteA2aAgent which translates ADK events to A2A 1. Create an environment file with your API key: ```bash - echo "GEMINI_API_KEY=your_api_key_here" > .env - + cp .env.example .env + # Edit .env with your actual API key (do not commit .env) ``` 2. Run subagents diff --git a/samples/agent/adk/restaurant_finder/.env.example b/samples/agent/adk/restaurant_finder/.env.example new file mode 100644 index 00000000..c4522b4e --- /dev/null +++ b/samples/agent/adk/restaurant_finder/.env.example @@ -0,0 +1,7 @@ +# Copy this file to .env and fill in your API key +# Get your API key at: https://aistudio.google.com/apikey + +GEMINI_API_KEY=your_gemini_api_key_here + +# Optional: Use Vertex AI instead of Gemini API +# GOOGLE_GENAI_USE_VERTEXAI=TRUE diff --git a/samples/agent/adk/restaurant_finder/README.md b/samples/agent/adk/restaurant_finder/README.md index 88596b71..0d1b7110 100644 --- a/samples/agent/adk/restaurant_finder/README.md +++ b/samples/agent/adk/restaurant_finder/README.md @@ -19,7 +19,8 @@ This sample uses the Agent Development Kit (ADK) along with the A2A protocol to 2. Create an environment file with your API key: ```bash - echo "GEMINI_API_KEY=your_api_key_here" > .env + cp .env.example .env + # Edit .env with your actual API key (do not commit .env) ``` 3. Run the agent server: diff --git a/samples/agent/adk/rizzcharts/.env.example b/samples/agent/adk/rizzcharts/.env.example new file mode 100644 index 00000000..c4522b4e --- /dev/null +++ b/samples/agent/adk/rizzcharts/.env.example @@ -0,0 +1,7 @@ +# Copy this file to .env and fill in your API key +# Get your API key at: https://aistudio.google.com/apikey + +GEMINI_API_KEY=your_gemini_api_key_here + +# Optional: Use Vertex AI instead of Gemini API +# GOOGLE_GENAI_USE_VERTEXAI=TRUE diff --git a/samples/agent/adk/rizzcharts/README.md b/samples/agent/adk/rizzcharts/README.md index 5fd542e4..b158d72a 100644 --- a/samples/agent/adk/rizzcharts/README.md +++ b/samples/agent/adk/rizzcharts/README.md @@ -19,8 +19,8 @@ This sample uses the Agent Development Kit (ADK) along with the A2A protocol to 2. Create an environment file with your API key: ```bash - echo "GEMINI_API_KEY=your_api_key_here" > .env - + cp .env.example .env + # Edit .env with your actual API key (do not commit .env) ``` 3. Run an agent: diff --git a/samples/client/angular/README.md b/samples/client/angular/README.md index ebd17555..1f048908 100644 --- a/samples/client/angular/README.md +++ b/samples/client/angular/README.md @@ -13,10 +13,9 @@ NOTE: [For the rizzcharts app](../../agent/adk/rizzcharts/), you will need Googl Here is the quickstart for the restaurant app: ```bash -# Export your Gemini API key -export GEMINI_API_KEY=your_gemini_api_key -echo "export GEMINI_API_KEY=your_gemini_api_key" >> .env -cp .env ../../agent/adk/restaurant_finder/.env +# Set up your Gemini API key +cp ../../agent/adk/restaurant_finder/.env.example ../../agent/adk/restaurant_finder/.env +# Edit the .env file with your actual API key (do not commit .env) # Start the restaurant app frontend npm install diff --git a/specification/0.8/eval/.env.example b/specification/0.8/eval/.env.example new file mode 100644 index 00000000..68337df8 --- /dev/null +++ b/specification/0.8/eval/.env.example @@ -0,0 +1,11 @@ +# Copy this file to .env and fill in your API keys +# You only need keys for the models you want to test + +# Gemini API Key - https://aistudio.google.com/apikey +GEMINI_API_KEY=your_gemini_api_key_here + +# OpenAI API Key - https://platform.openai.com/api-keys +OPENAI_API_KEY=your_openai_api_key_here + +# Anthropic API Key - https://console.anthropic.com/settings/keys +ANTHROPIC_API_KEY=your_anthropic_api_key_here diff --git a/specification/0.8/eval/README.md b/specification/0.8/eval/README.md index fbef16d3..5620d92b 100644 --- a/specification/0.8/eval/README.md +++ b/specification/0.8/eval/README.md @@ -12,6 +12,13 @@ To use the models, you need to set the following environment variables with your You can set these in a `.env` file in the root of the project, or in your shell's configuration file (e.g., `.bashrc`, `.zshrc`). +A `.env.example` file is provided as a template: + +```bash +cp .env.example .env +# Edit .env with your API keys (do not commit .env) +``` + You also need to install dependencies before running: ```bash diff --git a/specification/0.9/eval/.env.example b/specification/0.9/eval/.env.example new file mode 100644 index 00000000..68337df8 --- /dev/null +++ b/specification/0.9/eval/.env.example @@ -0,0 +1,11 @@ +# Copy this file to .env and fill in your API keys +# You only need keys for the models you want to test + +# Gemini API Key - https://aistudio.google.com/apikey +GEMINI_API_KEY=your_gemini_api_key_here + +# OpenAI API Key - https://platform.openai.com/api-keys +OPENAI_API_KEY=your_openai_api_key_here + +# Anthropic API Key - https://console.anthropic.com/settings/keys +ANTHROPIC_API_KEY=your_anthropic_api_key_here diff --git a/specification/0.9/eval/README.md b/specification/0.9/eval/README.md index 8e02d8ae..c85af9b4 100644 --- a/specification/0.9/eval/README.md +++ b/specification/0.9/eval/README.md @@ -14,6 +14,13 @@ To use the models, you need to set the following environment variables with your You can set these in a `.env` file in the root of the project, or in your shell's configuration file (e.g., `.bashrc`, `.zshrc`). +A `.env.example` file is provided as a template: + +```bash +cp .env.example .env +# Edit .env with your API keys (do not commit .env) +``` + You also need to install dependencies before running: ```bash