API key from Env Var support #18

daniel-lxs · 2025-10-09T18:45:12Z

Related GitHub Issue

Closes: #4337

Description

This PR adds support for obtaining API keys from the environment. A checkbox is added to each configuration that allows inputting an API key -- when checked, a given environment variable (eg, OPENAI_API_KEY, etc) is consulted for the key and the user is not required to provide one in the configuration. Env Var key is predictable but not editable.

Test Procedure

I tested this using VS Code run configurations, where the expected environment variable could be provided or omitted.

Pre-Submission Checklist

Issue Linked: This PR is linked to an approved GitHub Issue (see "Related GitHub Issue" above).
Scope: My changes are focused on the linked issue (one major feature/fix per PR).
Self-Review: I have performed a thorough self-review of my code.
Testing: New and/or updated tests have been added to cover my changes (if applicable).
Documentation Impact: I have considered if my changes require documentation updates (see "Documentation Updates" section below).

A documentation update is advised, to describe environment variable usage to supply API keys.

Contribution Guidelines: I have read and agree to the Contributor Guidelines.

Summary

Adds support for using environment variables for API keys across multiple providers, updates UI components to reflect this, and enhances testing and translation capabilities.

Behavior:
- Adds support for API keys from environment variables for providers like anthropic, glama, openrouter, openai, gemini, mistral, deepseek, unbound, requesty, xai, groq, chutes, litellm.
- Updates validateModelsAndKeysProvided() to check for environment variable usage for API keys.
UI Components:
- Introduces ApiKey component to handle API key input and environment variable toggle.
- Updates various provider components to use the new ApiKey component.
Testing:
- Adds comprehensive tests for environment variable integration and the ApiKey component.

Signed-off-by: Geoff Wilson <[email protected]>

…ssage Signed-off-by: Geoff Wilson <[email protected]>

Signed-off-by: Geoff Wilson <[email protected]>

…viders Signed-off-by: Geoff Wilson <[email protected]>

Signed-off-by: Geoff Wilson <[email protected]>

OPENAI_API_KEY env var Signed-off-by: Geoff Wilson <[email protected]>

Signed-off-by: Geoff Wilson <[email protected]>

whole process.env into webview Signed-off-by: Geoff Wilson <[email protected]>

of api key env var; use constants for env var keys. Signed-off-by: Geoff Wilson <[email protected]>

Signed-off-by: Geoff Wilson <[email protected]>

errant keys in test file Signed-off-by: Geoff Wilson <[email protected]>

Signed-off-by: Geoff Wilson <[email protected]>

vercel copy/pasta Signed-off-by: Geoff Wilson <[email protected]>

Signed-off-by: Geoff Wilson <[email protected]>

roo-code-dan · 2025-10-09T18:49:27Z

packages/types/src/constants.ts

+	FIREWORKS: 'FIREWORKS_API_KEY',
+	HUGGING_FACE: 'HUGGINGFACE_API_KEY',
+	IO_INTELLIGENCE: 'IOINTELLIGENCE_API_KEY',
+	MOONSHOOT: 'MOONSHOT_API_KEY',


Typo: MOONSHOOT should be MOONSHOT to match the naming convention of other constants (e.g., DEEP_SEEK, SAMBA_NOVA).

Suggested change

MOONSHOOT: 'MOONSHOT_API_KEY',

MOONSHOT: 'MOONSHOT_API_KEY',

roo-code-dan · 2025-10-09T18:50:08Z

webview-ui/src/components/settings/providers/Moonshot.tsx

-			</div>
+			<ApiKey
+				apiKey={apiConfiguration?.moonshotApiKey || ""}
+				apiKeyEnvVar={API_KEYS.MOONSHOOT}


This references the typo MOONSHOOT from constants.ts. Should be API_KEYS.MOONSHOT (without the extra 'O').

Suggested change

apiKeyEnvVar={API_KEYS.MOONSHOOT}

apiKeyEnvVar={API_KEYS.MOONSHOT}

roo-code-dan · 2025-10-09T18:50:33Z

src/api/index.ts

 			return new QwenCodeHandler(options)
 		case "moonshot":
+			if (options.moonshotConfigUseEnvVars) {
+				options.moonshotApiKey = getEnvVar(API_KEYS.MOONSHOOT, options.moonshotApiKey)


This also references the typo MOONSHOOT. Should be API_KEYS.MOONSHOT.

Suggested change

options.moonshotApiKey = getEnvVar(API_KEYS.MOONSHOOT, options.moonshotApiKey)

options.moonshotApiKey = getEnvVar(API_KEYS.MOONSHOT, options.moonshotApiKey)

roo-code-dan · 2025-10-09T18:51:09Z

webview-ui/src/components/settings/providers/Cerebras.tsx

-			},
-		[setApiConfigurationField],
-	)



Extra blank line - should be removed for consistency with other provider components.

suprjinx · 2025-10-23T18:34:55Z

Hi @daniel-lxs looks like there's an issue with MOONSHOT constant name -- do you want me to fix in the original PR?

suprjinx added 30 commits May 27, 2025 16:44

First cut on different UI

8d5d4f8

Signed-off-by: Geoff Wilson <[email protected]>

WIP for passing process environment to webview components

9391ede

Signed-off-by: Geoff Wilson <[email protected]>

Set process env in react html as script, instead of trying to pass me…

fa0504f

…ssage Signed-off-by: Geoff Wilson <[email protected]>

Fix logic for activating apiKeyEnvVar

39a1edb

Signed-off-by: Geoff Wilson <[email protected]>

Add new ApiKey component and use with Anthropic

91725fd

Signed-off-by: Geoff Wilson <[email protected]>

Add apiKeyUseEnvVar to all providers supporting api key

742ca14

Signed-off-by: Geoff Wilson <[email protected]>

Merge branch 'main' into add_api_key_env_vars

4fb7ed7

Signed-off-by: Geoff Wilson <[email protected]>

Fix merge errors

891af6d

Signed-off-by: Geoff Wilson <[email protected]>

Add unit tests for components/settings/ApiKey.tsx and api/index.ts

488ac44

Signed-off-by: Geoff Wilson <[email protected]>

Fix lint issues

910028d

Signed-off-by: Geoff Wilson <[email protected]>

Merge branch 'main' into add_api_key_env_vars

436025f

Add support for "balance display" used by OpenRouter and Requesty pro…

e17c2e6

…viders Signed-off-by: Geoff Wilson <[email protected]>

Fix additional unused vars

7e518b1

Signed-off-by: Geoff Wilson <[email protected]>

Fix new lint complaints after removing unused func

78598db

Signed-off-by: Geoff Wilson <[email protected]>

Add missing translation to non-EN locales

2f5e00f

Signed-off-by: Geoff Wilson <[email protected]>

Fix last lint complaint

60002d8

Signed-off-by: Geoff Wilson <[email protected]>

Fix missing imports

2b6b2ea

Signed-off-by: Geoff Wilson <[email protected]>

One more lint fix

f154eb2

Signed-off-by: Geoff Wilson <[email protected]>

Fix code scanner complaint re: potential prototype-pollution

674055c

Signed-off-by: Geoff Wilson <[email protected]>

Fix OpenAINative api key translation keys

88d587f

Signed-off-by: Geoff Wilson <[email protected]>

Merge branch 'main' into add_api_key_env_vars

1ea534c

Signed-off-by: Geoff Wilson <[email protected]>

PR suggestions to make "use env var" property more general; use

5706600

OPENAI_API_KEY env var Signed-off-by: Geoff Wilson <[email protected]>

Fix tsc compile issue

6f8b0d9

Signed-off-by: Geoff Wilson <[email protected]>

Switch to "ENV_VAR_EXISTS" map of known API keys, instead of writing

f9c6a51

whole process.env into webview Signed-off-by: Geoff Wilson <[email protected]>

Place a map of know api keys -> bool in webview for checking existence

2ff6dec

of api key env var; use constants for env var keys. Signed-off-by: Geoff Wilson <[email protected]>

Merge branch 'main' into add_api_key_env_vars

895b505

Signed-off-by: Geoff Wilson <[email protected]>

fix typo with chutes provider; remove redundant balanceDisplay and

11fe352

errant keys in test file Signed-off-by: Geoff Wilson <[email protected]>

Merge branch 'main' into add_api_key_env_vars

08e7d73

Signed-off-by: Geoff Wilson <[email protected]>

Remove unused env property for ApiOptions

0879bcd

Signed-off-by: Geoff Wilson <[email protected]>

Merge branch 'main' into add_api_key_env_vars

0231f6f

Signed-off-by: Geoff Wilson <[email protected]>

suprjinx and others added 23 commits August 13, 2025 10:59

Remove unused import from merge

6f7cace

Signed-off-by: Geoff Wilson <[email protected]>

Remove translations help function

ce8186d

Signed-off-by: Geoff Wilson <[email protected]>

Merge branch 'main' into add_api_key_env_vars

010300c

Fix formatting in test file; fix OllamaHandler reference

91206b1

Signed-off-by: Geoff Wilson <[email protected]>

Merge branch 'main' into add_api_key_env_vars

1076c2a

Signed-off-by: Geoff Wilson <[email protected]>

Fix merge error

8dd02bc

Signed-off-by: Geoff Wilson <[email protected]>

Fix merge error

6b82ada

Signed-off-by: Geoff Wilson <[email protected]>

Fix merge error

c0f82d8

Signed-off-by: Geoff Wilson <[email protected]>

Fix merge error

8868930

Signed-off-by: Geoff Wilson <[email protected]>

Merge branch 'main' into add_api_key_env_vars

86fd178

Signed-off-by: Geoff Wilson <[email protected]>

Remove unneeded but failing test case

b39fdb9

Signed-off-by: Geoff Wilson <[email protected]>

Merge branch 'main' into add_api_key_env_vars

bfe5486

Signed-off-by: Geoff Wilson <[email protected]>

Fix merge conflict

2fd04c5

Signed-off-by: Geoff Wilson <[email protected]>

Merge branch 'main' into add_api_key_env_vars

b2ef23c

Signed-off-by: Geoff Wilson <[email protected]>

Change DEEP_SEEK_API_KEY -> DEEPSEEK_API_KEY

6b32481

Signed-off-by: Geoff Wilson <[email protected]>

Change OPEN_ROUTER_API_KEY -> OPENROUTER_API_KEY

09dad33

Signed-off-by: Geoff Wilson <[email protected]>

Fix index.spec.ts header

2391628

Signed-off-by: Geoff Wilson <[email protected]>

Update validate function for ConfigUseEnvVar on existing providers

95fbe97

Signed-off-by: Geoff Wilson <[email protected]>

Additional providers having apikey

5ec88ba

Signed-off-by: Geoff Wilson <[email protected]>

Remove unused imports and defs since using ApiKey component

4736894

Signed-off-by: Geoff Wilson <[email protected]>

Use constants instead of hard-coded strings in buildApiHandler; fix

cc85602

vercel copy/pasta Signed-off-by: Geoff Wilson <[email protected]>

Fix Chutes translation key

d6f301f

Signed-off-by: Geoff Wilson <[email protected]>

Merge branch 'pr-6178' into feat/add-api-key-env-vars

4d20fac

roo-code-dan bot reviewed Oct 9, 2025

View reviewed changes

DanCodeInc deleted a comment from roo-code-dan bot Oct 9, 2025

daniel-lxs closed this Oct 23, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

API key from Env Var support #18

API key from Env Var support #18

Uh oh!

daniel-lxs commented Oct 9, 2025 •

edited

Loading

Uh oh!

roo-code-dan bot Oct 9, 2025

Uh oh!

roo-code-dan bot Oct 9, 2025

Uh oh!

roo-code-dan bot Oct 9, 2025

Uh oh!

roo-code-dan bot Oct 9, 2025

Uh oh!

suprjinx commented Oct 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	apiKeyEnvVar={API_KEYS.MOONSHOOT}
	apiKeyEnvVar={API_KEYS.MOONSHOT}

	options.moonshotApiKey = getEnvVar(API_KEYS.MOONSHOOT, options.moonshotApiKey)
	options.moonshotApiKey = getEnvVar(API_KEYS.MOONSHOT, options.moonshotApiKey)

API key from Env Var support #18

API key from Env Var support #18

Uh oh!

Conversation

daniel-lxs commented Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related GitHub Issue

Description

Test Procedure

Pre-Submission Checklist

Summary

Uh oh!

roo-code-dan bot Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

roo-code-dan bot Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

roo-code-dan bot Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

roo-code-dan bot Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

suprjinx commented Oct 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

daniel-lxs commented Oct 9, 2025 •

edited

Loading