chore: Add .env.example files to all examples

jsonbailey · claude · jsonbailey · commit 17c8bcbc2477 · 2026-05-13T12:39:30.000-05:00
Each example directory now ships a `.env.example` listing the env vars
that example reads, with empty values for the user to fill in. Each
per-example README now points at it with a `cp .env.example .env` step
instead of inlining the variable list.

`.env` is already covered by .gitignore.

Co-Authored-By: Claude Opus 4.7 (1M context) &lt;noreply@anthropic.com&gt;
diff --git a/features/create_agent/.env.example b/features/create_agent/.env.example
@@ -0,0 +1,8 @@
+# Your LaunchDarkly server-side SDK key
+LAUNCHDARKLY_SDK_KEY=
+
+# Provider API key(s) for the provider your agent config uses
+OPENAI_API_KEY=
+
+# Optional - defaults to "sample-agent"
+LAUNCHDARKLY_AGENT_KEY=
diff --git a/features/create_agent/README.md b/features/create_agent/README.md
@@ -15,12 +15,10 @@ This example demonstrates how to use LaunchDarkly's `create_agent` method, which
 
    - [Create an AI Agent Config](https://launchdarkly.com/docs/home/ai-configs/agents) with a model and agent instructions. Default key: `sample-agent`.
 
-1. Create a `.env` file in this directory with the following variables:
+1. Copy `.env.example` to `.env` and fill in your keys:
 
-   ```
-   LAUNCHDARKLY_SDK_KEY=your-launchdarkly-sdk-key
-   LAUNCHDARKLY_AGENT_KEY=sample-agent
-   OPENAI_API_KEY=your-openai-api-key
+   ```bash
+   cp .env.example .env
    ```
 
 1. Install the required dependencies:
diff --git a/features/create_agent_graph/.env.example b/features/create_agent_graph/.env.example
@@ -0,0 +1,8 @@
+# Your LaunchDarkly server-side SDK key
+LAUNCHDARKLY_SDK_KEY=
+
+# Provider API key(s) for the provider(s) your agent graph uses
+OPENAI_API_KEY=
+
+# Optional - defaults to "sample-agent-graph"
+LAUNCHDARKLY_AGENT_GRAPH_KEY=
diff --git a/features/create_agent_graph/README.md b/features/create_agent_graph/README.md
@@ -16,12 +16,10 @@ This example demonstrates how to use LaunchDarkly's `create_agent_graph` method,
    - [Create AI Agent Configs](https://launchdarkly.com/docs/home/ai-configs/agents) for each node in your graph. Configure each with a model and agent instructions. Add tools (e.g. `search_flights`, `search_hotels`, `get_weather`) to the agents that need them.
    - [Create an Agent Graph](https://launchdarkly.com/docs/home/ai-configs/create) that connects your agent configs as nodes with edges defining the workflow. Default key: `sample-agent-graph`.
 
-1. Create a `.env` file in this directory with the following variables:
+1. Copy `.env.example` to `.env` and fill in your keys:
 
-   ```
-   LAUNCHDARKLY_SDK_KEY=your-launchdarkly-sdk-key
-   LAUNCHDARKLY_AGENT_GRAPH_KEY=sample-agent-graph
-   OPENAI_API_KEY=your-openai-api-key
+   ```bash
+   cp .env.example .env
    ```
 
 1. Install the required dependencies:
diff --git a/features/create_judge/.env.example b/features/create_judge/.env.example
@@ -0,0 +1,8 @@
+# Your LaunchDarkly server-side SDK key
+LAUNCHDARKLY_SDK_KEY=
+
+# Provider API key(s) for the provider your judge config uses
+OPENAI_API_KEY=
+
+# Optional - defaults to "sample-judge"
+LAUNCHDARKLY_JUDGE_KEY=
diff --git a/features/create_judge/README.md b/features/create_judge/README.md
@@ -15,12 +15,10 @@ This example demonstrates how to use LaunchDarkly's `create_judge` method to eva
 
    - [Create a Judge Config](https://launchdarkly.com/docs/home/ai-configs/judges) for evaluation. Default key: `sample-judge`.
 
-1. Create a `.env` file in this directory with the following variables:
+1. Copy `.env.example` to `.env` and fill in your keys:
 
-   ```
-   LAUNCHDARKLY_SDK_KEY=your-launchdarkly-sdk-key
-   LAUNCHDARKLY_JUDGE_KEY=sample-judge
-   OPENAI_API_KEY=your-openai-api-key
+   ```bash
+   cp .env.example .env
    ```
 
 1. Install the required dependencies:
diff --git a/features/create_model/.env.example b/features/create_model/.env.example
@@ -0,0 +1,8 @@
+# Your LaunchDarkly server-side SDK key
+LAUNCHDARKLY_SDK_KEY=
+
+# Provider API key(s) for the provider your AI config uses
+OPENAI_API_KEY=
+
+# Optional - defaults to "sample-completion"
+LAUNCHDARKLY_COMPLETION_KEY=
diff --git a/features/create_model/README.md b/features/create_model/README.md
@@ -15,12 +15,10 @@ This example demonstrates how to use LaunchDarkly's `create_model` method, which
 
    - [Create an AI Config](https://launchdarkly.com/docs/home/ai-configs/create) with a model and system message. Default key: `sample-completion`.
 
-1. Create a `.env` file in this directory with the following variables:
+1. Copy `.env.example` to `.env` and fill in your keys:
 
-   ```
-   LAUNCHDARKLY_SDK_KEY=your-launchdarkly-sdk-key
-   LAUNCHDARKLY_COMPLETION_KEY=sample-completion
-   OPENAI_API_KEY=your-openai-api-key
+   ```bash
+   cp .env.example .env
    ```
 
 1. Install the required dependencies:
diff --git a/getting_started/bedrock/converse/.env.example b/getting_started/bedrock/converse/.env.example
@@ -0,0 +1,12 @@
+# Your LaunchDarkly server-side SDK key
+LAUNCHDARKLY_SDK_KEY=
+
+# Your AWS credentials for Bedrock access
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+
+# Optional - defaults to "us-east-1"
+AWS_DEFAULT_REGION=
+
+# Optional - defaults to "sample-completion"
+LAUNCHDARKLY_COMPLETION_KEY=
diff --git a/getting_started/bedrock/converse/README.md b/getting_started/bedrock/converse/README.md
@@ -15,24 +15,15 @@ This example demonstrates how to use LaunchDarkly's AI Config with the AWS Bedro
 
    - [Create an AI Config](https://launchdarkly.com/docs/home/ai-configs/create) with a Bedrock model and a system message. Default key: `sample-completion`.
 
-1. Create a `.env` file in this directory with the following variables:
+1. Copy `.env.example` to `.env` and fill in your keys:
 
+   ```bash
+   cp .env.example .env
    ```
-   LAUNCHDARKLY_SDK_KEY=your-launchdarkly-sdk-key
-   LAUNCHDARKLY_COMPLETION_KEY=sample-completion
-   ```
-
-   > `LAUNCHDARKLY_COMPLETION_KEY` defaults to `sample-completion` if not set.
 
-1. Ensure your AWS credentials can be [auto-detected by the `boto3` library](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html). You can set them in your `.env` file:
-
-   ```
-   AWS_ACCESS_KEY_ID=your-access-key-id
-   AWS_SECRET_ACCESS_KEY=your-secret-access-key
-   AWS_DEFAULT_REGION=us-east-1
-   ```
+   `LAUNCHDARKLY_COMPLETION_KEY` defaults to `sample-completion` if not set.
 
-   Other options include role providers or shared credential files.
+   Ensure your AWS credentials can be [auto-detected by the `boto3` library](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html). Setting them in `.env` is one option; role providers or shared credential files are also supported.
 
 1. Install the required dependencies:
 
diff --git a/getting_started/gemini/generate_content/.env.example b/getting_started/gemini/generate_content/.env.example
@@ -0,0 +1,8 @@
+# Your LaunchDarkly server-side SDK key
+LAUNCHDARKLY_SDK_KEY=
+
+# Your Google API key
+GOOGLE_API_KEY=
+
+# Optional - defaults to "sample-completion"
+LAUNCHDARKLY_COMPLETION_KEY=
diff --git a/getting_started/gemini/generate_content/README.md b/getting_started/gemini/generate_content/README.md
@@ -15,12 +15,10 @@ This example demonstrates how to use LaunchDarkly's AI Config with the Google Ge
 
    - [Create an AI Config](https://launchdarkly.com/docs/home/ai-configs/create) with a Gemini model (e.g. `gemini-2.0-flash`) and a system message. Default key: `sample-completion`.
 
-1. Create a `.env` file in this directory with the following variables:
+1. Copy `.env.example` to `.env` and fill in your keys:
 
-   ```
-   LAUNCHDARKLY_SDK_KEY=your-launchdarkly-sdk-key
-   LAUNCHDARKLY_COMPLETION_KEY=sample-completion
-   GOOGLE_API_KEY=your-google-api-key
+   ```bash
+   cp .env.example .env
    ```
 
 1. Install the required dependencies:
diff --git a/getting_started/langchain/invoke/.env.example b/getting_started/langchain/invoke/.env.example
@@ -0,0 +1,11 @@
+# Your LaunchDarkly server-side SDK key
+LAUNCHDARKLY_SDK_KEY=
+
+# Provider API keys - fill in the ones for the provider(s) your AI config uses
+OPENAI_API_KEY=
+GOOGLE_API_KEY=
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+
+# Optional - defaults to "sample-completion"
+LAUNCHDARKLY_COMPLETION_KEY=
diff --git a/getting_started/langchain/invoke/README.md b/getting_started/langchain/invoke/README.md
@@ -15,20 +15,10 @@ This example demonstrates how to use LaunchDarkly's AI Config with LangChain, su
 
    - [Create an AI Config](https://launchdarkly.com/docs/home/ai-configs/create) with a model and a system message. Default key: `sample-completion`.
 
-1. Create a `.env` file in this directory with the following variables:
+1. Copy `.env.example` to `.env` and fill in your keys (only the provider keys for providers you actually use are required):
 
-   ```
-   LAUNCHDARKLY_SDK_KEY=your-launchdarkly-sdk-key
-   LAUNCHDARKLY_COMPLETION_KEY=sample-completion
-   ```
-
-   Add the API keys for the providers you want to use:
-
-   ```
-   OPENAI_API_KEY=your-openai-api-key
-   GOOGLE_API_KEY=your-google-api-key
-   AWS_ACCESS_KEY_ID=your-access-key-id
-   AWS_SECRET_ACCESS_KEY=your-secret-access-key
+   ```bash
+   cp .env.example .env
    ```
 
 1. Install the required dependencies:
diff --git a/getting_started/langgraph/react_agent/.env.example b/getting_started/langgraph/react_agent/.env.example
@@ -0,0 +1,11 @@
+# Your LaunchDarkly server-side SDK key
+LAUNCHDARKLY_SDK_KEY=
+
+# Provider API keys - fill in the ones for the provider(s) your agent config uses
+OPENAI_API_KEY=
+GOOGLE_API_KEY=
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+
+# Optional - defaults to "sample-agent"
+LAUNCHDARKLY_AGENT_KEY=
diff --git a/getting_started/langgraph/react_agent/README.md b/getting_started/langgraph/react_agent/README.md
@@ -15,20 +15,10 @@ This example demonstrates how to use LaunchDarkly's AI Config with LangGraph to
 
    - [Create an AI Agent Config](https://launchdarkly.com/docs/home/ai-configs/agents) with a model and agent instructions. Default key: `sample-agent`.
 
-1. Create a `.env` file in this directory with the following variables:
+1. Copy `.env.example` to `.env` and fill in your keys (only the provider keys for providers you actually use are required):
 
-   ```
-   LAUNCHDARKLY_SDK_KEY=your-launchdarkly-sdk-key
-   LAUNCHDARKLY_AGENT_KEY=sample-agent
-   ```
-
-   Add the API keys for the providers you want to use:
-
-   ```
-   OPENAI_API_KEY=your-openai-api-key
-   GOOGLE_API_KEY=your-google-api-key
-   AWS_ACCESS_KEY_ID=your-access-key-id
-   AWS_SECRET_ACCESS_KEY=your-secret-access-key
+   ```bash
+   cp .env.example .env
    ```
 
 1. Install the required dependencies:
diff --git a/getting_started/langgraph/state_graph/.env.example b/getting_started/langgraph/state_graph/.env.example
@@ -0,0 +1,14 @@
+# Your LaunchDarkly server-side SDK key
+LAUNCHDARKLY_SDK_KEY=
+
+# Provider API keys - fill in the ones for the provider(s) your agent configs use
+OPENAI_API_KEY=
+GOOGLE_API_KEY=
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+
+# Optional - defaults to "code-review-analyzer"
+LAUNCHDARKLY_ANALYZER_KEY=
+
+# Optional - defaults to "code-review-documentation"
+LAUNCHDARKLY_DOCUMENTATION_KEY=
diff --git a/getting_started/langgraph/state_graph/README.md b/getting_started/langgraph/state_graph/README.md
@@ -16,21 +16,10 @@ This example demonstrates how to use LaunchDarkly's AI Config with LangGraph to
    - [Create an AI Agent Config](https://launchdarkly.com/docs/home/ai-configs/agents) for code analysis. Default key: `code-review-analyzer`.
    - [Create an AI Agent Config](https://launchdarkly.com/docs/home/ai-configs/agents) for documentation generation. Default key: `code-review-documentation`.
 
-1. Create a `.env` file in this directory with the following variables:
+1. Copy `.env.example` to `.env` and fill in your keys (only the provider keys for providers you actually use are required):
 
-   ```
-   LAUNCHDARKLY_SDK_KEY=your-launchdarkly-sdk-key
-   LAUNCHDARKLY_ANALYZER_CONFIG_KEY=code-review-analyzer
-   LAUNCHDARKLY_DOCUMENTATION_CONFIG_KEY=code-review-documentation
-   ```
-
-   Add the API keys for the providers you want to use:
-
-   ```
-   OPENAI_API_KEY=your-openai-api-key
-   GOOGLE_API_KEY=your-google-api-key
-   AWS_ACCESS_KEY_ID=your-access-key-id
-   AWS_SECRET_ACCESS_KEY=your-secret-access-key
+   ```bash
+   cp .env.example .env
    ```
 
 1. Install the required dependencies:
diff --git a/getting_started/openai/chat_completions/.env.example b/getting_started/openai/chat_completions/.env.example
@@ -0,0 +1,8 @@
+# Your LaunchDarkly server-side SDK key
+LAUNCHDARKLY_SDK_KEY=
+
+# Your OpenAI API key
+OPENAI_API_KEY=
+
+# Optional - defaults to "sample-completion"
+LAUNCHDARKLY_COMPLETION_KEY=
diff --git a/getting_started/openai/chat_completions/README.md b/getting_started/openai/chat_completions/README.md
@@ -15,12 +15,10 @@ This example demonstrates how to use LaunchDarkly's AI Config with the OpenAI pr
 
    - [Create an AI Config](https://launchdarkly.com/docs/home/ai-configs/create) with an OpenAI model (e.g. `gpt-4`) and a system message. Default key: `sample-completion`.
 
-1. Create a `.env` file in this directory with the following variables:
+1. Copy `.env.example` to `.env` and fill in your keys:
 
-   ```
-   LAUNCHDARKLY_SDK_KEY=your-launchdarkly-sdk-key
-   LAUNCHDARKLY_COMPLETION_KEY=sample-completion
-   OPENAI_API_KEY=your-openai-api-key
+   ```bash
+   cp .env.example .env
    ```
 
 1. Install the required dependencies:
