Skip to main content

DocsCommand

Enum DocsCommand 

Source
pub enum DocsCommand {
    List,
    Show {
        path: String,
        source: DocumentSource,
    },
    Ingest,
    Search {
        query: String,
        op: Option<String>,
        path: Vec<String>,
        tag: Vec<String>,
        limit: usize,
        format: String,
    },
    Override {
        force: bool,
    },
}
Expand description

Subcommands for the decapod docs CLI

Variantsยง

ยง

List

List all embedded Decapod methodology documents.

ยง

Show

Display the content of a specific embedded document.

Fields

ยงsource: DocumentSource

Source to display: embedded (binary), override (.decapod), or merged (default)

ยง

Ingest

Dump all embedded constitution for agentic ingestion.

ยง

Search

Return scoped constitution fragments relevant to a concrete query.

Fields

ยงquery: String

Problem/query text to scope against constitution docs.

ยงop: Option<String>

Optional operation context (e.g. workspace.ensure, store.upsert).

ยงpath: Vec<String>

Optional touched paths (repeatable).

ยงtag: Vec<String>

Optional intent tags (repeatable).

ยงlimit: usize

Max fragments to return.

ยงformat: String

Output format: text or json.

ยง

Override

Validate and cache OVERRIDE.md checksum.

Fields

ยงforce: bool

Force re-cache even if unchanged

Trait Implementationsยง

Sourceยง

impl Debug for DocsCommand

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl FromArgMatches for DocsCommand

Sourceยง

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Sourceยง

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Sourceยง

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Sourceยง

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Sourceยง

impl Subcommand for DocsCommand

Sourceยง

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Sourceยง

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Sourceยง

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

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> 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> Same for T

Sourceยง

type Output = T

Should always be Self
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.