Skip to main content

GrokConfiguration

Struct GrokConfiguration 

Source
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: String

Unique alias name; also used as the [model.<alias_name>] id.

§model: String

Underlying 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

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for GrokConfiguration

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for GrokConfiguration

Source§

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

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for GrokConfiguration

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for GrokConfiguration

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.