Struct ToolSpec 

pub struct ToolSpec { /* private fields */ }

Shared metadata for a CLI binary.

Implementations

impl ToolSpec

pub const fn new( bin_name: &'static str, display_name: &'static str, version: &'static str, license: LicenseType, repo: RepoInfo, supports_json: bool, supports_doctor: bool, ) -> ToolSpec

Create a new ToolSpec.

pub const fn workspace( bin_name: &'static str, display_name: &'static str, version: &'static str, license: LicenseType, supports_json: bool, supports_doctor: bool, ) -> ToolSpec

Create a new ToolSpec using WORKSPACE_REPO.

pub const fn with_agent_surface( self, agent_surface: &'static AgentSurfaceSpec, ) -> ToolSpec

Attach an agent surface to the tool specification.

pub const fn bin_name(&self) -> &'static str

Return the binary name.

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

Return the human-readable tool name.

pub const fn version(&self) -> &'static str

Return the tool version.

pub const fn agent_surface(&self) -> Option<&'static AgentSurfaceSpec>

Return the agent surface, if configured.

pub const fn supports_json(&self) -> bool

Whether the tool supports JSON output in base commands.

pub const fn supports_doctor(&self) -> bool

Whether the tool exposes doctor checks.

pub const fn has_authoritative_contract(&self) -> bool

Whether the tool has opted into the authoritative shared CLI contract.

pub const fn validate_authoritative_contract(&self) -> Result<(), ContractError>

Validate that the tool uses the authoritative shared CLI contract.

Errors

Returns ContractError::NotAuthoritative when the tool still relies on legacy advisory flags.

Trait Implementations

impl Clone for ToolSpec

fn clone(&self) -> ToolSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolSpec

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

Formats the value using the given formatter.