tkmind/tkmind_go
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

chore: show important keys for provider configuration (#7265)

Browse Source
This commit is contained in:
Lifei Zhou
2026-02-18 18:10:53 +11:00
committed by GitHub
parent cc51ec0941
commit 5dacfde2f3
29 changed files with 283 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/goose/src/providers/anthropic.rs
+2 -1
View File
@@ -153,12 +153,13 @@ impl ProviderDef for AnthropicProvider {
models,
ANTHROPIC_DOC_URL,
vec![
ConfigKey::new("ANTHROPIC_API_KEY", true, true, None),
ConfigKey::new("ANTHROPIC_API_KEY", true, true, None, true),
ConfigKey::new(
"ANTHROPIC_HOST",
true,
false,
Some("https://api.anthropic.com"),
false,
),
],
)
crates/goose/src/providers/azure.rs
+10 -4
View File
@@ -55,10 +55,16 @@ impl ProviderDef for AzureProvider {
AZURE_OPENAI_KNOWN_MODELS.to_vec(),
AZURE_DOC_URL,
vec![
ConfigKey::new("AZURE_OPENAI_ENDPOINT", true, false, None),
ConfigKey::new("AZURE_OPENAI_DEPLOYMENT_NAME", true, false, None),
ConfigKey::new("AZURE_OPENAI_API_VERSION", true, false, Some("2024-10-21")),
ConfigKey::new("AZURE_OPENAI_API_KEY", false, true, Some("")),
ConfigKey::new("AZURE_OPENAI_ENDPOINT", true, false, None, true),
ConfigKey::new("AZURE_OPENAI_DEPLOYMENT_NAME", true, false, None, true),
ConfigKey::new(
"AZURE_OPENAI_API_VERSION",
true,
false,
Some("2024-10-21"),
false,
),
ConfigKey::new("AZURE_OPENAI_API_KEY", false, true, Some(""), true),
],
)
}
crates/goose/src/providers/base.rs
+22 -3
View File
@@ -205,27 +205,39 @@ pub struct ConfigKey {
/// Whether this key should be configured using OAuth device code flow
/// When true, the provider's configure_oauth() method will be called instead of prompting for manual input
pub oauth_flow: bool,
/// Whether this key should be shown prominently during provider setup
/// (onboarding, settings modal, CLI configure)
#[serde(default)]
pub primary: bool,
}
impl ConfigKey {
/// Create a new ConfigKey
pub fn new(name: &str, required: bool, secret: bool, default: Option<&str>) -> Self {
pub fn new(
name: &str,
required: bool,
secret: bool,
default: Option<&str>,
primary: bool,
) -> Self {
Self {
name: name.to_string(),
required,
secret,
default: default.map(|s| s.to_string()),
oauth_flow: false,
primary,
}
}
pub fn from_value_type<T: ConfigValue>(required: bool, secret: bool) -> Self {
pub fn from_value_type<T: ConfigValue>(required: bool, secret: bool, primary: bool) -> Self {
Self {
name: T::KEY.to_string(),
required,
secret,
default: Some(T::DEFAULT.to_string()),
oauth_flow: false,
primary,
}
}
@@ -233,13 +245,20 @@ impl ConfigKey {
///
/// This is used for providers that support OAuth authentication instead of manual API key entry.
/// When oauth_flow is true, the configuration system will call the provider's configure_oauth() method.
pub fn new_oauth(name: &str, required: bool, secret: bool, default: Option<&str>) -> Self {
pub fn new_oauth(
name: &str,
required: bool,
secret: bool,
default: Option<&str>,
primary: bool,
) -> Self {
Self {
name: name.to_string(),
required,
secret,
default: default.map(|s| s.to_string()),
oauth_flow: true,
primary,
}
}
}
crates/goose/src/providers/bedrock.rs
+3 -3
View File
@@ -277,9 +277,9 @@ impl ProviderDef for BedrockProvider {
BEDROCK_KNOWN_MODELS.to_vec(),
BEDROCK_DOC_LINK,
vec![
ConfigKey::new("AWS_PROFILE", false, false, Some("default")),
ConfigKey::new("AWS_REGION", false, false, None),
ConfigKey::new("AWS_BEARER_TOKEN_BEDROCK", false, true, None),
ConfigKey::new("AWS_PROFILE", false, false, Some("default"), true),
ConfigKey::new("AWS_REGION", false, false, None, true),
ConfigKey::new("AWS_BEARER_TOKEN_BEDROCK", false, true, None, true),
],
)
}
crates/goose/src/providers/chatgpt_codex.rs
+1
View File
@@ -861,6 +861,7 @@ impl ProviderDef for ChatGptCodexProvider {
true,
true,
None,
false,
)],
)
.with_unlisted_models()
crates/goose/src/providers/claude_code.rs
+3 -1
View File
@@ -483,7 +483,9 @@ impl ProviderDef for ClaudeCodeProvider {
// Only a few agentic choices; fetched dynamically via fetch_supported_models.
vec![],
CLAUDE_CODE_DOC_URL,
vec![ConfigKey::from_value_type::<ClaudeCodeCommand>(true, false)],
vec![ConfigKey::from_value_type::<ClaudeCodeCommand>(
true, false, true,
)],
)
// The model list only returns aliases the `claude` CLI uses, such as "default"
// and "haiku". There is no listing that includes full names like
crates/goose/src/providers/codex.rs
+3 -3
View File
@@ -600,9 +600,9 @@ impl ProviderDef for CodexProvider {
CODEX_KNOWN_MODELS.to_vec(),
CODEX_DOC_URL,
vec![
ConfigKey::from_value_type::<CodexCommand>(true, false),
ConfigKey::from_value_type::<CodexReasoningEffort>(false, false),
ConfigKey::from_value_type::<CodexSkipGitCheck>(false, false),
ConfigKey::from_value_type::<CodexCommand>(true, false, true),
ConfigKey::from_value_type::<CodexReasoningEffort>(false, false, true),
ConfigKey::from_value_type::<CodexSkipGitCheck>(false, false, true),
],
)
.with_unlisted_models()
crates/goose/src/providers/cursor_agent.rs
+1 -1
View File
@@ -291,7 +291,7 @@ impl ProviderDef for CursorAgentProvider {
CURSOR_AGENT_KNOWN_MODELS.to_vec(),
CURSOR_AGENT_DOC_URL,
vec![ConfigKey::from_value_type::<CursorAgentCommand>(
true, false,
true, false, true,
)],
)
.with_unlisted_models()
crates/goose/src/providers/databricks.rs
+2 -2
View File
@@ -246,8 +246,8 @@ impl ProviderDef for DatabricksProvider {
DATABRICKS_KNOWN_MODELS.to_vec(),
DATABRICKS_DOC_URL,
vec![
ConfigKey::new("DATABRICKS_HOST", true, false, None),
ConfigKey::new("DATABRICKS_TOKEN", false, true, None),
ConfigKey::new("DATABRICKS_HOST", true, false, None, true),
ConfigKey::new("DATABRICKS_TOKEN", false, true, None, true),
],
)
}
crates/goose/src/providers/gcpvertexai.rs
+6 -1
View File
@@ -503,36 +503,41 @@ impl ProviderDef for GcpVertexAIProvider {
KNOWN_MODELS.to_vec(),
GCP_VERTEX_AI_DOC_URL,
vec![
ConfigKey::new("GCP_PROJECT_ID", true, false, None),
ConfigKey::new("GCP_PROJECT_ID", true, false, None, true),
ConfigKey::new(
"GCP_LOCATION",
true,
false,
Some(&GcpLocation::Iowa.to_string()),
true,
),
ConfigKey::new(
"GCP_MAX_RETRIES",
false,
false,
Some(&DEFAULT_MAX_RETRIES.to_string()),
false,
),
ConfigKey::new(
"GCP_INITIAL_RETRY_INTERVAL_MS",
false,
false,
Some(&DEFAULT_INITIAL_RETRY_INTERVAL_MS.to_string()),
false,
),
ConfigKey::new(
"GCP_BACKOFF_MULTIPLIER",
false,
false,
Some(&DEFAULT_BACKOFF_MULTIPLIER.to_string()),
false,
),
ConfigKey::new(
"GCP_MAX_RETRY_INTERVAL_MS",
false,
false,
Some(&DEFAULT_MAX_RETRY_INTERVAL_MS.to_string()),
false,
),
],
)
crates/goose/src/providers/gemini_cli.rs
+3 -1
View File
@@ -306,7 +306,9 @@ impl ProviderDef for GeminiCliProvider {
GEMINI_CLI_DEFAULT_MODEL,
GEMINI_CLI_KNOWN_MODELS.to_vec(),
GEMINI_CLI_DOC_URL,
vec![ConfigKey::from_value_type::<GeminiCliCommand>(true, false)],
vec![ConfigKey::from_value_type::<GeminiCliCommand>(
true, false, true,
)],
)
.with_unlisted_models()
}
crates/goose/src/providers/githubcopilot.rs
+1
View File
@@ -395,6 +395,7 @@ impl ProviderDef for GithubCopilotProvider {
true,
true,
None,
false,
)],
)
}
crates/goose/src/providers/google.rs
+2 -2
View File
@@ -117,8 +117,8 @@ impl ProviderDef for GoogleProvider {
GOOGLE_KNOWN_MODELS.to_vec(),
GOOGLE_DOC_URL,
vec![
ConfigKey::new("GOOGLE_API_KEY", true, true, None),
ConfigKey::new("GOOGLE_HOST", false, false, Some(GOOGLE_API_HOST)),
ConfigKey::new("GOOGLE_API_KEY", true, true, None, true),
ConfigKey::new("GOOGLE_HOST", false, false, Some(GOOGLE_API_HOST), false),
],
)
}
crates/goose/src/providers/litellm.rs
+11 -4
View File
@@ -145,16 +145,23 @@ impl ProviderDef for LiteLLMProvider {
vec![],
LITELLM_DOC_URL,
vec![
ConfigKey::new("LITELLM_API_KEY", true, true, None),
ConfigKey::new("LITELLM_HOST", true, false, Some("http://localhost:4000")),
ConfigKey::new("LITELLM_API_KEY", true, true, None, true),
ConfigKey::new(
"LITELLM_HOST",
true,
false,
Some("http://localhost:4000"),
true,
),
ConfigKey::new(
"LITELLM_BASE_PATH",
true,
false,
Some("v1/chat/completions"),
false,
),
ConfigKey::new("LITELLM_CUSTOM_HEADERS", false, true, None),
ConfigKey::new("LITELLM_TIMEOUT", false, false, Some("600")),
ConfigKey::new("LITELLM_CUSTOM_HEADERS", false, true, None, false),
ConfigKey::new("LITELLM_TIMEOUT", false, false, Some("600"), false),
],
)
}
crates/goose/src/providers/ollama.rs
+2 -1
View File
@@ -158,12 +158,13 @@ impl ProviderDef for OllamaProvider {
OLLAMA_KNOWN_MODELS.to_vec(),
OLLAMA_DOC_URL,
vec![
ConfigKey::new("OLLAMA_HOST", true, false, Some(OLLAMA_HOST)),
ConfigKey::new("OLLAMA_HOST", true, false, Some(OLLAMA_HOST), true),
ConfigKey::new(
"OLLAMA_TIMEOUT",
false,
false,
Some(&(OLLAMA_TIMEOUT.to_string())),
false,
),
],
)
crates/goose/src/providers/openai.rs
+19 -7
View File
@@ -285,13 +285,25 @@ impl ProviderDef for OpenAiProvider {
models,
OPEN_AI_DOC_URL,
vec![
ConfigKey::new("OPENAI_API_KEY", false, true, None),
ConfigKey::new("OPENAI_HOST", true, false, Some("https://api.openai.com")),
ConfigKey::new("OPENAI_BASE_PATH", true, false, Some("v1/chat/completions")),
ConfigKey::new("OPENAI_ORGANIZATION", false, false, None),
ConfigKey::new("OPENAI_PROJECT", false, false, None),
ConfigKey::new("OPENAI_CUSTOM_HEADERS", false, true, None),
ConfigKey::new("OPENAI_TIMEOUT", false, false, Some("600")),
ConfigKey::new("OPENAI_API_KEY", false, true, None, true),
ConfigKey::new(
"OPENAI_HOST",
true,
false,
Some("https://api.openai.com"),
false,
),
ConfigKey::new(
"OPENAI_BASE_PATH",
true,
false,
Some("v1/chat/completions"),
false,
),
ConfigKey::new("OPENAI_ORGANIZATION", false, false, None, false),
ConfigKey::new("OPENAI_PROJECT", false, false, None, false),
ConfigKey::new("OPENAI_CUSTOM_HEADERS", false, true, None, false),
ConfigKey::new("OPENAI_TIMEOUT", false, false, Some("600"), false),
],
)
}
crates/goose/src/providers/openrouter.rs
+2 -1
View File
@@ -158,12 +158,13 @@ impl ProviderDef for OpenRouterProvider {
OPENROUTER_KNOWN_MODELS.to_vec(),
OPENROUTER_DOC_URL,
vec![
ConfigKey::new("OPENROUTER_API_KEY", true, true, None),
ConfigKey::new("OPENROUTER_API_KEY", true, true, None, true),
ConfigKey::new(
"OPENROUTER_HOST",
false,
false,
Some("https://openrouter.ai"),
false,
),
],
)
crates/goose/src/providers/provider_registry.rs
+7 -2
View File
@@ -109,8 +109,13 @@ impl ProviderRegistry {
config_keys.remove(api_key_index);
} else if !config.api_key_env.is_empty() {
let api_key_required = provider_type == ProviderType::Declarative;
config_keys[api_key_index] =
super::base::ConfigKey::new(&config.api_key_env, api_key_required, true, None);
config_keys[api_key_index] = super::base::ConfigKey::new(
&config.api_key_env,
api_key_required,
true,
None,
true,
);
}
}
crates/goose/src/providers/sagemaker_tgi.rs
+3 -3
View File
@@ -284,9 +284,9 @@ impl ProviderDef for SageMakerTgiProvider {
vec![SAGEMAKER_TGI_DEFAULT_MODEL],
SAGEMAKER_TGI_DOC_LINK,
vec![
ConfigKey::new("SAGEMAKER_ENDPOINT_NAME", false, false, None),
ConfigKey::new("AWS_REGION", true, false, Some("us-east-1")),
ConfigKey::new("AWS_PROFILE", true, false, Some("default")),
ConfigKey::new("SAGEMAKER_ENDPOINT_NAME", true, false, None, true),
ConfigKey::new("AWS_REGION", true, false, Some("us-east-1"), true),
ConfigKey::new("AWS_PROFILE", true, false, Some("default"), true),
],
)
}
crates/goose/src/providers/snowflake.rs
+2 -2
View File
@@ -309,8 +309,8 @@ impl ProviderDef for SnowflakeProvider {
SNOWFLAKE_KNOWN_MODELS.to_vec(),
SNOWFLAKE_DOC_URL,
vec![
ConfigKey::new("SNOWFLAKE_HOST", true, false, None),
ConfigKey::new("SNOWFLAKE_TOKEN", true, true, None),
ConfigKey::new("SNOWFLAKE_HOST", true, false, None, true),
ConfigKey::new("SNOWFLAKE_TOKEN", true, true, None, true),
],
)
}
crates/goose/src/providers/tetrate.rs
+2 -1
View File
@@ -75,12 +75,13 @@ impl ProviderDef for TetrateProvider {
TETRATE_KNOWN_MODELS.to_vec(),
TETRATE_DOC_URL,
vec![
ConfigKey::new("TETRATE_API_KEY", true, true, None),
ConfigKey::new("TETRATE_API_KEY", true, true, None, true),
ConfigKey::new(
"TETRATE_HOST",
false,
false,
Some("https://api.router.tetrate.ai"),
false,
),
],
)
crates/goose/src/providers/venice.rs
+4 -2
View File
@@ -205,19 +205,21 @@ impl ProviderDef for VeniceProvider {
FALLBACK_MODELS.to_vec(),
VENICE_DOC_URL,
vec![
ConfigKey::new("VENICE_API_KEY", true, true, None),
ConfigKey::new("VENICE_HOST", true, false, Some(VENICE_DEFAULT_HOST)),
ConfigKey::new("VENICE_API_KEY", true, true, None, true),
ConfigKey::new("VENICE_HOST", true, false, Some(VENICE_DEFAULT_HOST), false),
ConfigKey::new(
"VENICE_BASE_PATH",
true,
false,
Some(VENICE_DEFAULT_BASE_PATH),
false,
),
ConfigKey::new(
"VENICE_MODELS_PATH",
true,
false,
Some(VENICE_DEFAULT_MODELS_PATH),
false,
),
],
)
crates/goose/src/providers/xai.rs
+2 -2
View File
@@ -45,8 +45,8 @@ impl ProviderDef for XaiProvider {
XAI_KNOWN_MODELS.to_vec(),
XAI_DOC_URL,
vec![
ConfigKey::new("XAI_API_KEY", true, true, None),
ConfigKey::new("XAI_HOST", false, false, Some(XAI_API_HOST)),
ConfigKey::new("XAI_API_KEY", true, true, None, true),
ConfigKey::new("XAI_HOST", false, false, Some(XAI_API_HOST), false),
],
)
}