Import / export

Author: cte

src/core/__tests__/contextProxy.test.ts

@@ -1,5 +1,7 @@
 // npx jest src/core/__tests__/contextProxy.test.ts
 
+import fs from "fs/promises"
+
 import * as vscode from "vscode"
 import { ContextProxy } from "../contextProxy"
 
@@ -416,4 +418,76 @@ describe("ContextProxy", () => {
 			expect(initializeSpy).toHaveBeenCalledTimes(1)
 		})
 	})
+
+	describe("exportGlobalConfiguration", () => {
+		it("should write configuration to a file when filePath is provided", async () => {
+			await proxy.updateGlobalState("apiModelId", "gpt-4")
+			await proxy.updateGlobalState("apiProvider", "openai")
+			await proxy.storeSecret("openAiApiKey", "test-api-key")
+
+			const filePath = `/tmp/roo-global-config-${Date.now()}.json`
+			const result = await proxy.exportGlobalConfiguration(filePath)
+			expect(result).toEqual({ apiProvider: "openai" })
+			const fileContent = await fs.readFile(filePath, "utf-8")
+			expect(fileContent).toContain('"apiProvider": "openai"')
+
+			await proxy.updateGlobalState("apiProvider", "openrouter")
+
+			const importedConfig = await proxy.importGlobalConfiguration(filePath)
+			expect(importedConfig).toEqual({ apiProvider: "openai" })
+
+			await fs.unlink(filePath)
+		})
+	})
+
+	describe("exportApiConfiguration", () => {
+		it("should write configuration to a file when filePath is provided", async () => {
+			await proxy.updateGlobalState("apiModelId", "gpt-4")
+			await proxy.updateGlobalState("apiProvider", "openai")
+			await proxy.storeSecret("openAiApiKey", "test-api-key")
+
+			const filePath = `/tmp/roo-api-config-${Date.now()}.json`
+			const result = await proxy.exportApiConfiguration(filePath)
+			expect(result).toEqual({
+				apiModelId: "gpt-4",
+				openAiApiKey: "test-api-key",
+				apiKey: "test-secret",
+				awsAccessKey: "test-secret",
+				awsSecretKey: "test-secret",
+				awsSessionToken: "test-secret",
+				deepSeekApiKey: "test-secret",
+				geminiApiKey: "test-secret",
+				glamaApiKey: "test-secret",
+				mistralApiKey: "test-secret",
+				openAiNativeApiKey: "test-secret",
+				openRouterApiKey: "test-secret",
+				requestyApiKey: "test-secret",
+				unboundApiKey: "test-secret",
+			})
+			const fileContent = await fs.readFile(filePath, "utf-8")
+			expect(fileContent).toContain('"openAiApiKey": "test-api-key"')
+
+			await proxy.storeSecret("openAiApiKey", "new-text-api-key")
+
+			const importedConfig = await proxy.importApiConfiguration(filePath)
+			expect(importedConfig).toEqual({
+				apiModelId: "gpt-4",
+				openAiApiKey: "test-api-key",
+				apiKey: "test-secret",
+				awsAccessKey: "test-secret",
+				awsSecretKey: "test-secret",
+				awsSessionToken: "test-secret",
+				deepSeekApiKey: "test-secret",
+				geminiApiKey: "test-secret",
+				glamaApiKey: "test-secret",
+				mistralApiKey: "test-secret",
+				openAiNativeApiKey: "test-secret",
+				openRouterApiKey: "test-secret",
+				requestyApiKey: "test-secret",
+				unboundApiKey: "test-secret",
+			})
+
+			await fs.unlink(filePath)
+		})
+	})
 })

src/core/contextProxy.ts

@@ -1,4 +1,6 @@
 import * as vscode from "vscode"
+import * as fs from "fs/promises"
+import * as path from "path"
 
 import { logger } from "../utils/logging"
 import {
@@ -11,8 +13,22 @@ import {
 	isSecretKey,
 	isGlobalStateKey,
 	isPassThroughStateKey,
+	globalStateSchema,
 } from "../shared/globalState"
-import { API_CONFIG_KEYS, ApiConfiguration } from "../shared/api"
+import { API_CONFIG_KEYS, ApiConfiguration, apiHandlerOptionsSchema, ApiHandlerOptionsKey } from "../shared/api"
+
+const NON_EXPORTABLE_GLOBAL_CONFIGURATION: GlobalStateKey[] = [
+	"taskHistory",
+	"listApiConfigMeta",
+	"currentApiConfigName",
+]
+
+const NON_EXPORTABLE_API_CONFIGURATION: ApiHandlerOptionsKey[] = [
+	"glamaModelInfo",
+	"openRouterModelInfo",
+	"unboundModelInfo",
+	"requestyModelInfo",
+]
 
 export class ContextProxy {
 	private readonly originalContext: vscode.ExtensionContext
@@ -155,14 +171,125 @@ export class ContextProxy {
 		// that the setting's value should be `undefined` and therefore we
 		// need to remove it from the state cache if it exists.
 		await this.setValues({
-			...API_CONFIG_KEYS.filter((key) => !!this.stateCache.get(key)).reduce(
-				(acc, key) => ({ ...acc, [key]: undefined }),
-				{} as Partial<ConfigurationValues>,
-			),
+			...API_CONFIG_KEYS.filter((key) => isGlobalStateKey(key))
+				.filter((key) => !!this.stateCache.get(key))
+				.reduce((acc, key) => ({ ...acc, [key]: undefined }), {} as Partial<ConfigurationValues>),
 			...apiConfiguration,
 		})
 	}
 
+	private getAllGlobalStateValues() {
+		const values: Partial<Record<GlobalStateKey, any>> = {}
+
+		for (const key of GLOBAL_STATE_KEYS) {
+			const value = this.getGlobalState(key)
+
+			if (value !== undefined) {
+				values[key] = value
+			}
+		}
+
+		return values
+	}
+
+	private getAllSecretValues() {
+		const values: Partial<Record<SecretKey, string>> = {}
+
+		for (const key of SECRET_KEYS) {
+			const value = this.getSecret(key)
+
+			if (value !== undefined) {
+				values[key] = value
+			}
+		}
+
+		return values
+	}
+
+	async exportGlobalConfiguration(filePath: string) {
+		try {
+			const values = this.getAllGlobalStateValues()
+			const configuration = globalStateSchema.parse(values)
+			const omit = new Set<string>([...API_CONFIG_KEYS, ...NON_EXPORTABLE_GLOBAL_CONFIGURATION])
+			const entries = Object.entries(configuration).filter(([key]) => !omit.has(key))
+
+			if (entries.length === 0) {
+				throw new Error("No configuration values to export.")
+			}
+
+			const globalConfiguration = Object.fromEntries(entries)
+
+			const dirname = path.dirname(filePath)
+			await fs.mkdir(dirname, { recursive: true })
+			await fs.writeFile(filePath, JSON.stringify(globalConfiguration, null, 2), "utf-8")
+			return globalConfiguration
+		} catch (error) {
+			console.log(error.message)
+			logger.error(
+				`Error exporting global configuration to ${filePath}: ${error instanceof Error ? error.message : String(error)}`,
+			)
+			return undefined
+		}
+	}
+
+	async importGlobalConfiguration(filePath: string) {
+		try {
+			const configuration = globalStateSchema.parse(JSON.parse(await fs.readFile(filePath, "utf-8")))
+			const omit = new Set<string>([...API_CONFIG_KEYS, ...NON_EXPORTABLE_GLOBAL_CONFIGURATION])
+			const entries = Object.entries(configuration).filter(([key]) => !omit.has(key))
+
+			if (entries.length === 0) {
+				throw new Error("No configuration values to import.")
+			}
+
+			const globalConfiguration = Object.fromEntries(entries)
+			await this.setValues(globalConfiguration)
+			return globalConfiguration
+		} catch (error) {
+			logger.error(
+				`Error importing global configuration from ${filePath}: ${error instanceof Error ? error.message : String(error)}`,
+			)
+			return undefined
+		}
+	}
+
+	async exportApiConfiguration(filePath: string) {
+		try {
+			const apiConfiguration = apiHandlerOptionsSchema
+				.omit(NON_EXPORTABLE_API_CONFIGURATION.reduce((acc, key) => ({ ...acc, [key]: true }), {}))
+				.parse({
+					...this.getAllGlobalStateValues(),
+					...this.getAllSecretValues(),
+				})
+
+			const dirname = path.dirname(filePath)
+			await fs.mkdir(dirname, { recursive: true })
+			await fs.writeFile(filePath, JSON.stringify(apiConfiguration, null, 2), "utf-8")
+			return apiConfiguration
+		} catch (error) {
+			logger.error(
+				`Error exporting API configuration to ${filePath}: ${error instanceof Error ? error.message : String(error)}`,
+			)
+			return undefined
+		}
+	}
+
+	async importApiConfiguration(filePath: string) {
+		try {
+			const apiConfiguration = apiHandlerOptionsSchema
+				.omit(NON_EXPORTABLE_API_CONFIGURATION.reduce((acc, key) => ({ ...acc, [key]: true }), {}))
+				.parse(JSON.parse(await fs.readFile(filePath, "utf-8")))
+
+			await this.setApiConfiguration(apiConfiguration)
+			return apiConfiguration
+		} catch (error) {
+			logger.error(
+				`Error importing API configuration from ${filePath}: ${error instanceof Error ? error.message : String(error)}`,
+			)
+			return undefined
+		}
+	}
+
 	/**
 	 * Resets all global state, secrets, and in-memory caches.
 	 * This clears all data from both the in-memory caches and the VSCode storage.
@@ -184,6 +311,6 @@ export class ContextProxy {
 		// Wait for all reset operations to complete.
 		await Promise.all([...stateResetPromises, ...secretResetPromises])
 
-		this.initialize()
+		await this.initialize()
 	}
 }

src/core/webview/ClineProvider.ts

@@ -31,6 +31,7 @@ import {
 	SECRET_KEYS,
 	GLOBAL_STATE_KEYS,
 	ConfigurationValues,
+	isGlobalStateKey,
 } from "../../shared/globalState"
 import { HistoryItem } from "../../shared/HistoryItem"
 import { ApiConfigMeta, ExtensionMessage } from "../../shared/ExtensionMessage"
@@ -99,6 +100,7 @@ export class ClineProvider extends EventEmitter<ClineProviderEvents> implements
 	private workspaceTracker?: WorkspaceTracker
 	protected mcpHub?: McpHub // Change from private to protected
 	private latestAnnouncementId = "mar-20-2025-3-10" // update to some unique identifier when we add a new announcement
+	private settingsImportedAt?: number
 	private contextProxy: ContextProxy
 	configManager: ConfigManager
 	customModesManager: CustomModesManager
@@ -1070,6 +1072,41 @@ export class ClineProvider extends EventEmitter<ClineProviderEvents> implements
 					}
 					case "exportTaskWithId":
 						this.exportTaskWithId(message.text!)
+						break
+					case "importSettings":
+						const uris = await vscode.window.showOpenDialog({
+							filters: { JSON: ["json"] },
+							canSelectMany: false,
+						})
+
+						if (uris) {
+							if (message.text === "global") {
+								await this.contextProxy.importGlobalConfiguration(uris[0].fsPath)
+							} else {
+								await this.contextProxy.importApiConfiguration(uris[0].fsPath)
+							}
+
+							this.settingsImportedAt = Date.now()
+							await this.postStateToWebview()
+							await vscode.window.showInformationMessage(t("common:info.settings_imported"))
+						}
+						break
+					case "exportSettings":
+						const uri = await vscode.window.showSaveDialog({
+							filters: { JSON: ["json"] },
+							defaultUri: vscode.Uri.file(
+								path.join(os.homedir(), "Documents", `roo-code-${message.text}.json`),
+							),
+						})
+
+						if (uri) {
+							if (message.text === "global") {
+								await this.contextProxy.exportGlobalConfiguration(uri.fsPath)
+							} else {
+								await this.contextProxy.exportApiConfiguration(uri.fsPath)
+							}
+						}
+
 						break
 					case "resetState":
 						await this.resetState()
@@ -2582,6 +2619,7 @@ export class ClineProvider extends EventEmitter<ClineProviderEvents> implements
 			language,
 			renderContext: this.renderContext,
 			maxReadFileLine: maxReadFileLine ?? 500,
+			settingsImportedAt: this.settingsImportedAt,
 		}
 	}
 
@@ -2671,7 +2709,9 @@ export class ClineProvider extends EventEmitter<ClineProviderEvents> implements
 		// Using the dynamic approach with API_CONFIG_KEYS
 		const apiConfiguration: ApiConfiguration = {
 			// Dynamically add all API-related keys from stateValues
-			...Object.fromEntries(API_CONFIG_KEYS.map((key) => [key, stateValues[key]])),
+			...Object.fromEntries(
+				API_CONFIG_KEYS.filter((key) => isGlobalStateKey(key)).map((key) => [key, stateValues[key]]),
+			),
 			// Add all secrets
 			...secretValues,
 		}

src/i18n/locales/en/common.json

@@ -61,7 +61,8 @@
 		"mcp_server_restarting": "Restarting {{serverName}} MCP server...",
 		"mcp_server_connected": "{{serverName}} MCP server connected",
 		"mcp_server_deleted": "Deleted MCP server: {{serverName}}",
-		"mcp_server_not_found": "Server \"{{serverName}}\" not found in configuration"
+		"mcp_server_not_found": "Server \"{{serverName}}\" not found in configuration",
+		"settings_imported": "Settings imported successfully."
 	},
 	"answers": {
 		"yes": "Yes",

src/shared/ExtensionMessage.ts

@@ -168,6 +168,7 @@ export interface ExtensionState {
 	showRooIgnoredFiles: boolean // Whether to show .rooignore'd files in listings
 	renderContext: "sidebar" | "editor"
 	maxReadFileLine: number // Maximum number of lines to read from a file before truncating
+	settingsImportedAt?: number
 }
 
 export type { ClineMessage, ClineAsk, ClineSay }

src/shared/WebviewMessage.ts

@@ -34,6 +34,8 @@ export interface WebviewMessage {
 		| "showTaskWithId"
 		| "deleteTaskWithId"
 		| "exportTaskWithId"
+		| "importSettings"
+		| "exportSettings"
 		| "resetState"
 		| "requestOllamaModels"
 		| "requestLmStudioModels"