Skip to main content

AciCommandContract

Struct AciCommandContract 

Source
pub struct AciCommandContract {
    pub app_id: String,
    pub name: String,
    pub cmd_path: String,
    pub node_type: NodeType,
    pub description: String,
    pub risk_level: RiskLevel,
    pub example_template: Option<String>,
    pub install_instructions: Option<InstallInstructions>,
    pub docker_image: Option<String>,
    pub script_url: Option<String>,
    pub source_url: Option<String>,
}
Expand description

The core ACI command contract returned by CmdHub search.

This is the primary data structure that AI Agents consume. It provides everything needed to discover, understand, and execute a CLI command.

Fields§

§app_id: String

Unique identifier (e.g., “org.github.mtoyoda.sl”)

§name: String

Base command name (e.g., “sl”)

§cmd_path: String

Materialized path (e.g., “sl.-l”, “gh.pr.create”)

§node_type: NodeType

Hierarchical level

§description: String

Agent-friendly description

§risk_level: RiskLevel

Security risk rating

§example_template: Option<String>

Ready-to-execute template (e.g., “sl -l”)

§install_instructions: Option<InstallInstructions>

Cross-platform install commands

§docker_image: Option<String>

Docker container image for isolated execution

§script_url: Option<String>

Direct URL to official install shell scripts

§source_url: Option<String>

URL of the open-source code repository

Implementations§

Source§

impl AciCommandContract

Source

pub fn node_name(&self) -> &str

Extracts the node name from the cmd_path (the last component after ‘.’)

Source

pub fn to_db_records(&self) -> Result<(DbApp, DbArgument), CmdHubError>

Converts this contract into offline SQLite database records.

Trait Implementations§

Source§

impl Clone for AciCommandContract

Source§

fn clone(&self) -> AciCommandContract

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AciCommandContract

Source§

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

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

impl<'de> Deserialize<'de> for AciCommandContract

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 AciCommandContract

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

impl TryFrom<DbAciRecord> for AciCommandContract

Source§

type Error = CmdHubError

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

fn try_from(record: DbAciRecord) -> Result<Self, Self::Error>

Performs the conversion.

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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