Struct CodexSurface 

pub struct CodexSurface;

Codex agent surface. Stateless; the registry stores it as Box<dyn AgentSurface>.

Implementations

impl CodexSurface

pub const AGENT_ID: &'static str = "codex"

pub const AGENTS_MD: &'static str = "AGENTS.md"

Filename of the markdown file Codex reads from the repo root.

pub const PRE_COMMIT_RELPATH: &'static [&'static str]

Repo-relative path of the git pre-commit hook.

pub const PRE_PUSH_RELPATH: &'static [&'static str]

Repo-relative path of the git pre-push hook.

pub const HOOK_RELPATH: &'static [&'static str] = Self::PRE_COMMIT_RELPATH

Repo-relative path of the primary hook reported via the trait’s hook_path method. Kept as pre-commit for parity with the W1 API; consumers needing both paths should use Self::all_hook_paths.

pub fn all_hook_paths(repo_root: &Path) -> [(HookKind, PathBuf); 2]

Both managed hook paths, in install order. W3 callers that want to render the full install report (e.g. for klasp install --dry-run) should iterate this rather than relying on the trait’s single hook_path.

pub fn install_detailed( &self, ctx: &InstallContext, ) -> Result<CodexInstallReport, InstallError>

Detailed install entry-point. Returns the standard InstallReport and the list of HookWarnings collected from the hook writer. The trait’s AgentSurface::install method calls this and discards the warnings to keep the cross-crate trait surface unchanged; W3’s CLI plumbing calls this method directly so it can render warnings to the user.

Trait Implementations

impl AgentSurface for CodexSurface

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

Stable agent identifier (e.g. "claude_code", "codex").

fn detect(&self, repo_root: &Path) -> bool

Auto-detect whether this surface is relevant to the given repo (e.g. presence of .claude/ for Claude Code, AGENTS.md for Codex). klasp install --force overrides a false here.

fn hook_path(&self, repo_root: &Path) -> PathBuf

Path to the hook-script file this surface owns.

fn settings_path(&self, repo_root: &Path) -> PathBuf

Path to the agent’s settings/config file this surface mutates.

fn render_hook_script(&self, ctx: &InstallContext) -> String

Render the hook-script content this surface would write. Pure — no filesystem access. Used by install and by --dry-run.

fn install(&self, ctx: &InstallContext) -> Result<InstallReport, InstallError>

Perform the install. Must be idempotent: running twice with the same input yields the same on-disk state and returns already_installed = true on the second run.

fn uninstall( &self, repo_root: &Path, dry_run: bool, ) -> Result<Vec<PathBuf>, InstallError>

Remove klasp’s managed entries. Returns the list of paths that were (or would be, in dry_run) modified. Sibling hooks must be preserved.