pub struct GrokConfiguration {
pub alias_name: String,
pub model: String,
pub base_url: Option<String>,
pub name: Option<String>,
pub api_backend: Option<String>,
pub context_window: Option<u32>,
pub api_key: Option<String>,
pub env_key: Option<Vec<String>>,
pub extra_headers: Option<HeaderMap>,
}Expand description
GrokConfiguration represents a custom third-party model definition for the
grok CLI (xAI), stored under [model.<alias_name>] in ~/.grok/config.toml.
The env-based auth path (env_key) is the primary way to supply credentials;
api_key is an alternative that writes the key directly to disk.
Fields§
§alias_name: StringUnique alias name; also used as the [model.<alias_name>] id.
model: StringUnderlying model id (e.g. “claude-opus-4-6”).
base_url: Option<String>API endpoint base URL.
name: Option<String>Human-friendly display name.
api_backend: Option<String>API backend: “chat_completions” | “responses” | “messages”.
context_window: Option<u32>Context window size.
api_key: Option<String>API key written directly into config (secondary to env_key).
env_key: Option<Vec<String>>Environment variable name(s) to read the key from (primary path).
extra_headers: Option<HeaderMap>Extra HTTP headers (e.g. x-api-key, anthropic-version) for the model.
Trait Implementations§
Source§impl Clone for GrokConfiguration
impl Clone for GrokConfiguration
Source§impl Debug for GrokConfiguration
impl Debug for GrokConfiguration
Source§impl<'de> Deserialize<'de> for GrokConfiguration
impl<'de> Deserialize<'de> for GrokConfiguration
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl PartialEq for GrokConfiguration
impl PartialEq for GrokConfiguration
Source§impl Serialize for GrokConfiguration
impl Serialize for GrokConfiguration
impl StructuralPartialEq for GrokConfiguration
Auto Trait Implementations§
impl Freeze for GrokConfiguration
impl RefUnwindSafe for GrokConfiguration
impl Send for GrokConfiguration
impl Sync for GrokConfiguration
impl Unpin for GrokConfiguration
impl UnsafeUnpin for GrokConfiguration
impl UnwindSafe for GrokConfiguration
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more