Struct CodexAgent 

pub struct CodexAgent { /* private fields */ }

Codex CLI.

Implementations

impl CodexAgent

pub const fn new() -> Self

Construct an instance. Stateless.

Trait Implementations

impl Clone for CodexAgent

fn clone(&self) -> CodexAgent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodexAgent

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

Formats the value using the given formatter.

impl Default for CodexAgent

fn default() -> CodexAgent

Returns the “default value” for a type.

impl InstructionSurface for CodexAgent

fn id(&self) -> &'static str

Stable, kebab-case identifier matching Integration::id for the same agent.

fn supported_instruction_scopes(&self) -> &'static [ScopeKind]

Which scopes this instruction installer accepts.

fn instruction_status( &self, scope: &Scope, name: &str, expected_owner: &str, ) -> Result<StatusReport, AgentConfigError>

Detailed installation state for the instruction identified by name, scored against expected_owner.

fn plan_install_instruction( &self, scope: &Scope, spec: &InstructionSpec, ) -> Result<InstallPlan, AgentConfigError>

Plan an instruction install without mutating user files.

fn plan_uninstall_instruction( &self, scope: &Scope, name: &str, owner_tag: &str, ) -> Result<UninstallPlan, AgentConfigError>

Plan an instruction uninstall without mutating user files.

fn install_instruction( &self, scope: &Scope, spec: &InstructionSpec, ) -> Result<InstallReport, AgentConfigError>

Install (or update) the instruction. Repeated calls with the same name and identical content are a no-op after the first.

fn uninstall_instruction( &self, scope: &Scope, name: &str, owner_tag: &str, ) -> Result<UninstallReport, AgentConfigError>

Uninstall the instruction identified by name, owned by owner_tag. Returns AgentConfigError::NotOwnedByCaller on owner mismatch.

fn is_instruction_installed( &self, scope: &Scope, name: &str, ) -> Result<bool, AgentConfigError>

Returns true if an instruction named name is currently recorded under any owner in this scope’s ownership ledger.

fn validate_instruction( &self, scope: &Scope, name: &str, ) -> Result<ValidationReport, AgentConfigError>

Validate instruction state without mutating user files.

fn validate_instruction_for_owner( &self, scope: &Scope, name: &str, expected_owner: Option<&str>, ) -> Result<ValidationReport, AgentConfigError>

Validate instruction state against a caller-supplied expected owner.

impl Integration for CodexAgent

fn id(&self) -> &'static str

Stable, kebab-case identifier (e.g., "claude", "cursor").

fn display_name(&self) -> &'static str

Human-readable name (e.g., "Claude Code").

fn supported_scopes(&self) -> &'static [ScopeKind]

Which scopes this integration accepts.

fn status( &self, scope: &Scope, tag: &str, ) -> Result<StatusReport, AgentConfigError>

Detailed installation state for the hook identified by tag.

fn plan_install( &self, scope: &Scope, spec: &HookSpec, ) -> Result<InstallPlan, AgentConfigError>

Plan a hook install without mutating user files.

fn plan_uninstall( &self, scope: &Scope, tag: &str, ) -> Result<UninstallPlan, AgentConfigError>

Plan a hook uninstall without mutating user files.

fn install( &self, scope: &Scope, spec: &HookSpec, ) -> Result<InstallReport, AgentConfigError>

Install the hook. Repeated calls with the same spec.tag are a no-op after the first (the on-disk state is reached, then preserved).

fn uninstall( &self, scope: &Scope, tag: &str, ) -> Result<UninstallReport, AgentConfigError>

Uninstall the hook identified by tag. Restores .bak files when removing our content leaves the target file empty or pristine.

fn is_installed( &self, scope: &Scope, tag: &str, ) -> Result<bool, AgentConfigError>

Returns true if a hook with this tag is currently installed in this scope. Used by CLI consumers to render install/uninstall state.

fn validate( &self, scope: &Scope, tag: &str, ) -> Result<ValidationReport, AgentConfigError>

Validate hook state without mutating user files.

fn migrate( &self, _scope: &Scope, _tag: &str, ) -> Result<MigrationReport, AgentConfigError>

Migrate any prior layout produced by an earlier version of the consumer (e.g., remove a legacy shell-script wrapper that has since been superseded by a native binary). Default impl is a no-op.

impl McpSurface for CodexAgent

fn id(&self) -> &'static str

Stable, kebab-case identifier matching Integration::id for the same agent (e.g., "claude").

fn supported_mcp_scopes(&self) -> &'static [ScopeKind]

Which scopes this MCP installer accepts.

fn mcp_status( &self, scope: &Scope, name: &str, expected_owner: &str, ) -> Result<StatusReport, AgentConfigError>

Detailed installation state for the MCP server identified by name, scored against expected_owner.

fn plan_install_mcp( &self, scope: &Scope, spec: &McpSpec, ) -> Result<InstallPlan, AgentConfigError>

Plan an MCP server install without mutating user files.

fn plan_uninstall_mcp( &self, scope: &Scope, name: &str, owner_tag: &str, ) -> Result<UninstallPlan, AgentConfigError>

Plan an MCP server uninstall without mutating user files.

fn install_mcp( &self, scope: &Scope, spec: &McpSpec, ) -> Result<InstallReport, AgentConfigError>

Install (or update) the MCP server. Repeated calls with the same spec.name and same content are a no-op after the first.

fn uninstall_mcp( &self, scope: &Scope, name: &str, owner_tag: &str, ) -> Result<UninstallReport, AgentConfigError>

Uninstall the MCP server identified by name, owned by owner_tag.

fn is_mcp_installed( &self, scope: &Scope, name: &str, ) -> Result<bool, AgentConfigError>

Returns true if a server with name is currently recorded under any owner in this scope’s ownership ledger.

fn validate_mcp( &self, scope: &Scope, name: &str, ) -> Result<ValidationReport, AgentConfigError>

Validate MCP state without mutating user files.

fn validate_mcp_for_owner( &self, scope: &Scope, name: &str, expected_owner: Option<&str>, ) -> Result<ValidationReport, AgentConfigError>

Validate MCP state against a caller-supplied expected owner.

impl SkillSurface for CodexAgent

fn id(&self) -> &'static str

Stable, kebab-case identifier matching Integration::id for the same agent.

fn supported_skill_scopes(&self) -> &'static [ScopeKind]

Which scopes this skill installer accepts.

fn skill_status( &self, scope: &Scope, name: &str, expected_owner: &str, ) -> Result<StatusReport, AgentConfigError>

Detailed installation state for the skill identified by name, scored against expected_owner. See McpSurface::mcp_status for the owner-comparison semantics.

fn plan_install_skill( &self, scope: &Scope, spec: &SkillSpec, ) -> Result<InstallPlan, AgentConfigError>

Plan a skill install without mutating user files.

fn plan_uninstall_skill( &self, scope: &Scope, name: &str, owner_tag: &str, ) -> Result<UninstallPlan, AgentConfigError>

Plan a skill uninstall without mutating user files.

fn install_skill( &self, scope: &Scope, spec: &SkillSpec, ) -> Result<InstallReport, AgentConfigError>

Install (or update) the skill directory and record ownership. Repeated calls with byte-identical contents are a no-op after the first.

fn uninstall_skill( &self, scope: &Scope, name: &str, owner_tag: &str, ) -> Result<UninstallReport, AgentConfigError>

Uninstall the skill identified by name, owned by owner_tag. Returns AgentConfigError::NotOwnedByCaller on owner mismatch or when the skill exists on disk but is missing from the ledger.

fn is_skill_installed( &self, scope: &Scope, name: &str, ) -> Result<bool, AgentConfigError>

Returns true if a skill named name is currently recorded in the ownership ledger for this scope.

fn validate_skill( &self, scope: &Scope, name: &str, ) -> Result<ValidationReport, AgentConfigError>

Validate skill state without mutating user files.

fn validate_skill_for_owner( &self, scope: &Scope, name: &str, expected_owner: Option<&str>, ) -> Result<ValidationReport, AgentConfigError>

Validate skill state against a caller-supplied expected owner.

impl Copy for CodexAgent