Skip to main content

OpenCodeConfig

Struct OpenCodeConfig 

Source
pub struct OpenCodeConfig {
    pub cli_path: PathBuf,
    pub model: String,
    pub mcp_server_path: Option<PathBuf>,
    pub timeout: Duration,
    pub working_dir: Option<PathBuf>,
    pub env_vars: Vec<(String, String)>,
    pub platform: Option<String>,
}
Expand description

Configuration for OpenCode CLI integration

Fields§

§cli_path: PathBuf

Path to the OpenCode CLI binary

§model: String

Model to use (e.g., “zai-coding-plan/glm-4.7”)

§mcp_server_path: Option<PathBuf>

Path to the MCP server binary (for RAG integration)

§timeout: Duration

Timeout for CLI operations

§working_dir: Option<PathBuf>

Working directory for OpenCode (defaults to codebase path)

§env_vars: Vec<(String, String)>

Additional environment variables to pass to OpenCode

§platform: Option<String>

Platform name for prompt customization (e.g., “Shopify”, “WordPress”, “Salesforce”) Loaded from GATEKPR_PLATFORM or SHOPIFY_APPROVER_PLATFORM env var. Defaults to “Shopify” if not set.

Implementations§

Source§

impl OpenCodeConfig

Source

pub fn new() -> Result<Self>

Create a new configuration with auto-detected CLI path

Source

pub fn with_cli_path(cli_path: PathBuf) -> Self

Create configuration with explicit CLI path

Source

pub fn from_env() -> Result<Self>

Create configuration from environment variables

Environment variables:

  • OPENCODE_CLI_PATH: Path to opencode binary
  • OPENCODE_MODEL: Model to use (default: zai-coding-plan/glm-4.7)
  • OPENCODE_TIMEOUT: Timeout in seconds (default: 120)
  • MCP_SERVER_PATH: Path to gatekpr-mcp-server binary
  • GATEKPR_PLATFORM or SHOPIFY_APPROVER_PLATFORM: Platform name (default: “Shopify”)
Source

pub fn with_model(self, model: impl Into<String>) -> Self

Set the model to use

Source

pub fn with_mcp_server(self, path: PathBuf) -> Self

Set the MCP server path

Source

pub fn with_timeout(self, timeout: Duration) -> Self

Set the timeout

Source

pub fn with_working_dir(self, dir: PathBuf) -> Self

Set the working directory

Source

pub fn with_env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add an environment variable

Source

pub fn validate(&self) -> Result<()>

Validate the configuration

Source

pub fn has_mcp(&self) -> bool

Check if MCP integration is available

Trait Implementations§

Source§

impl Clone for OpenCodeConfig

Source§

fn clone(&self) -> OpenCodeConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OpenCodeConfig

Source§

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

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

impl Default for OpenCodeConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for OpenCodeConfig

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 Serialize for OpenCodeConfig

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

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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