Enum SdkPluginConfig 

pub enum SdkPluginConfig {
    Local {
        path: PathBuf,
    },
}

Plugin configuration for extending Claude Code functionality

Plugins can be loaded from local filesystem paths and provide additional tools, features, or integrations that Claude can use during execution.

Examples

use claude_agent_sdk::SdkPluginConfig;
use std::path::PathBuf;

// Load a local plugin
let plugin = SdkPluginConfig::Local {
    path: PathBuf::from("./my-plugin"),
};

Variants

Local

Local filesystem plugin

Loads a plugin from a local directory path. The path should point to a valid Claude Code plugin directory structure.

Example

use claude_agent_sdk::SdkPluginConfig;
use std::path::PathBuf;

let plugin = SdkPluginConfig::Local {
    path: PathBuf::from("~/.claude/plugins/my-plugin"),
};

Fields

path: PathBuf

Path to the plugin directory

Implementations

impl SdkPluginConfig

pub fn local(path: impl Into<PathBuf>) -> Self

Create a new local plugin configuration

Examples

use claude_agent_sdk::SdkPluginConfig;

let plugin = SdkPluginConfig::local("./my-plugin");

pub fn path(&self) -> Option<&PathBuf>

Get the path for a local plugin

Returns Some(&PathBuf) for local plugins, None for other types.

Examples

use claude_agent_sdk::SdkPluginConfig;

let plugin = SdkPluginConfig::local("./my-plugin");
assert!(plugin.path().is_some());

Trait Implementations

impl Clone for SdkPluginConfig

fn clone(&self) -> SdkPluginConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SdkPluginConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SdkPluginConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SdkPluginConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SdkPluginConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SdkPluginConfig

impl StructuralPartialEq for SdkPluginConfig