Skip to main content

Commands

spreadsheet_mcp::cli

Enum Commands 

Source 
pub enum Commands {

Show 44 variants    ListSheets {
        file: PathBuf,
        session: Option<String>,
        session_workspace: Option<PathBuf>,
    },
    SheetOverview {
        file: PathBuf,
        sheet: String,
        session: Option<String>,
        session_workspace: Option<PathBuf>,
    },
    RangeValues {
        file: PathBuf,
        sheet: String,
        ranges: Vec<String>,
        format: Option<RangeValuesFormatArg>,
        include_formulas: Option<bool>,
        session: Option<String>,
        session_workspace: Option<PathBuf>,
    },
    RangeExport {
        file: PathBuf,
        sheet: String,
        range: String,
        format: String,
        output: Option<String>,
        include_formulas: Option<bool>,
        session: Option<String>,
        session_workspace: Option<PathBuf>,
    },
    RangeImport {
        file: PathBuf,
        sheet: String,
        anchor: String,
        from_grid: Option<String>,
        from_csv: Option<String>,
        header: bool,
        clear_target: bool,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
    },
    InspectCells {
        file: PathBuf,
        sheet: String,
        targets: Vec<String>,
        include_empty: bool,
        budget: Option<u32>,
        session: Option<String>,
        session_workspace: Option<PathBuf>,
    },
    SheetPage {
        file: PathBuf,
        sheet: String,
        start_row: Option<u32>,
        page_size: Option<u32>,
        columns: Option<Vec<String>>,
        columns_by_header: Option<Vec<String>>,
        include_formulas: Option<bool>,
        include_styles: Option<bool>,
        include_header: Option<bool>,
        format: SheetPageFormatArg,
        session: Option<String>,
        session_workspace: Option<PathBuf>,
    },
    ReadTable {
Show 13 fields
        file: PathBuf,
        sheet: Option<String>,
        range: Option<String>,
        table_name: Option<String>,
        region_id: Option<u32>,
        limit: Option<u32>,
        offset: Option<u32>,
        sample_mode: Option<TableSampleModeArg>,
        filters_json: Option<String>,
        filters_file: Option<PathBuf>,
        table_format: Option<TableReadFormat>,
        session: Option<String>,
        session_workspace: Option<PathBuf>,
    
},
    FindValue {
        file: PathBuf,
        query: String,
        sheet: Option<String>,
        mode: Option<FindValueMode>,
        label_direction: Option<LabelDirectionArg>,
        session: Option<String>,
        session_workspace: Option<PathBuf>,
    },
    NamedRanges {
        file: PathBuf,
        sheet: Option<String>,
        name_prefix: Option<String>,
        session: Option<String>,
        session_workspace: Option<PathBuf>,
    },
    DefineName {
        file: PathBuf,
        name: String,
        refers_to: String,
        scope: Option<String>,
        scope_sheet_name: Option<String>,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
    },
    UpdateName {
        file: PathBuf,
        name: String,
        refers_to: Option<String>,
        scope: Option<String>,
        scope_sheet_name: Option<String>,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
    },
    DeleteName {
        file: PathBuf,
        name: String,
        scope: Option<String>,
        scope_sheet_name: Option<String>,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
    },
    FindFormula {
        file: PathBuf,
        query: String,
        sheet: Option<String>,
        limit: Option<u32>,
        offset: Option<u32>,
    },
    ScanVolatiles {
        file: PathBuf,
        sheet: Option<String>,
        limit: Option<u32>,
        offset: Option<u32>,
        formula_parse_policy: Option<FormulaParsePolicy>,
    },
    SheetStatistics {
        file: PathBuf,
        sheet: String,
    },
    FormulaMap {
        file: PathBuf,
        sheet: String,
        limit: Option<u32>,
        sort_by: Option<FormulaSort>,
        formula_parse_policy: Option<FormulaParsePolicy>,
    },
    FormulaTrace {
        file: PathBuf,
        sheet: String,
        cell: String,
        direction: TraceDirectionArg,
        depth: Option<u32>,
        page_size: Option<usize>,
        cursor_depth: Option<u32>,
        cursor_offset: Option<usize>,
        formula_parse_policy: Option<FormulaParsePolicy>,
        session: Option<String>,
        session_workspace: Option<PathBuf>,
    },
    Describe {
        file: PathBuf,
        session: Option<String>,
        session_workspace: Option<PathBuf>,
    },
    TableProfile {
        file: PathBuf,
        sheet: Option<String>,
        session: Option<String>,
        session_workspace: Option<PathBuf>,
    },
    LayoutPage {
        file: PathBuf,
        sheet: String,
        range_positional: Option<String>,
        range: Option<String>,
        mode: Option<LayoutModeArg>,
        max_col_width: Option<u32>,
        fit_columns: bool,
        skip_empty_columns_trim: bool,
        render: Option<LayoutRenderArg>,
        session: Option<String>,
        session_workspace: Option<PathBuf>,
    },
    CreateWorkbook {
        path: PathBuf,
        sheets: Option<Vec<String>>,
        overwrite: bool,
    },
    Copy {
        source: PathBuf,
        dest: PathBuf,
    },
    Edit {
        file: PathBuf,
        sheet: String,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
        edits: Vec<String>,
        edits_file: Option<PathBuf>,
        formula_parse_policy: Option<FormulaParsePolicy>,
    },
    AppendRegion {
        file: PathBuf,
        sheet_name: String,
        region_id: Option<u32>,
        table_name: Option<String>,
        rows: Option<String>,
        from_csv: Option<String>,
        header: bool,
        footer_policy: AppendRegionFooterPolicyArg,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
    },
    CloneTemplateRow {
Show 14 fields
        file: PathBuf,
        sheet_name: String,
        source_row: u32,
        before: Option<u32>,
        after: Option<u32>,
        insert_at: Option<u32>,
        count: u32,
        expand_adjacent_sums: bool,
        patch_targets: ClonePatchTargetsArg,
        merge_policy: CloneMergePolicyArg,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
    
},
    CloneRowBand {
Show 14 fields
        file: PathBuf,
        sheet_name: String,
        source_rows: String,
        before: Option<u32>,
        after: Option<u32>,
        insert_at: Option<u32>,
        repeat: u32,
        expand_adjacent_sums: bool,
        patch_targets: ClonePatchTargetsArg,
        merge_policy: CloneMergePolicyArg,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
    
},
    TransformBatch {
        file: Option<PathBuf>,
        ops: Option<String>,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
        print_schema: bool,
        formula_parse_policy: Option<FormulaParsePolicy>,
    },
    StyleBatch {
        file: Option<PathBuf>,
        ops: Option<String>,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
        print_schema: bool,
    },
    ApplyFormulaPattern {
        file: Option<PathBuf>,
        ops: Option<String>,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
        print_schema: bool,
    },
    StructureBatch {
        file: Option<PathBuf>,
        ops: Option<String>,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
        print_schema: bool,
        formula_parse_policy: Option<FormulaParsePolicy>,
        impact_report: bool,
        show_formula_delta: bool,
    },
    CheckRefImpact {
        file: PathBuf,
        ops: String,
        show_formula_delta: bool,
    },
    ColumnSizeBatch {
        file: Option<PathBuf>,
        ops: Option<String>,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
        print_schema: bool,
    },
    SheetLayoutBatch {
        file: Option<PathBuf>,
        ops: Option<String>,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
        print_schema: bool,
    },
    RulesBatch {
        file: Option<PathBuf>,
        ops: Option<String>,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
        print_schema: bool,
        formula_parse_policy: Option<FormulaParsePolicy>,
    },
    Sheetport {
        command: SheetportCommands,
    },
    ReplaceInFormulas {
        file: PathBuf,
        sheet: String,
        find: String,
        replace: String,
        range: Option<String>,
        regex: bool,
        case_sensitive: Option<bool>,
        dry_run: bool,
        in_place: bool,
        output: Option<PathBuf>,
        force: bool,
        formula_parse_policy: Option<FormulaParsePolicy>,
    },
    Recalculate {
        file: PathBuf,
        output: Option<PathBuf>,
        force: bool,
        ignore_sheets: Option<Vec<String>>,
        changed_cells: bool,
    },
    Verify {
        baseline: PathBuf,
        current: PathBuf,
        targets: Option<Vec<String>>,
        sheet_name: Option<String>,
        named_ranges: bool,
        errors_only: bool,
        targets_only: bool,
    },
    Diff {
        original: PathBuf,
        modified: PathBuf,
        sheet: Option<String>,
        sheets: Option<Vec<String>>,
        range: Option<String>,
        details: bool,
        exclude_recalc_result: bool,
        limit: u32,
        offset: u32,
    },
    Schema {
        command: DiscoverabilityCommands,
    },
    Example {
        command: DiscoverabilityCommands,
    },
    Session(Box<SessionCommands>),
    RunManifest {
        file: PathBuf,
        manifest: PathBuf,
        inputs: Option<String>,
        rng_seed: Option<u64>,
        freeze_volatile: bool,
    },

}

Variants§

§

ListSheets

Fields

§file: PathBuf
§session: Option<String>
§session_workspace: Option<PathBuf>
§

SheetOverview

Fields

§file: PathBuf
§sheet: String
§session: Option<String>
§session_workspace: Option<PathBuf>
§

RangeValues

Fields

§file: PathBuf
§sheet: String
§ranges: Vec<String>
§format: Option<RangeValuesFormatArg>
§include_formulas: Option<bool>
§session: Option<String>
§session_workspace: Option<PathBuf>
§

RangeExport

Fields

§file: PathBuf
§sheet: String
§range: String
§format: String
§output: Option<String>
§include_formulas: Option<bool>
§session: Option<String>
§session_workspace: Option<PathBuf>
§

RangeImport

Fields

§file: PathBuf
§sheet: String
§anchor: String
§from_grid: Option<String>
§from_csv: Option<String>
§header: bool
§clear_target: bool
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§

InspectCells

Fields

§file: PathBuf
§sheet: String
§targets: Vec<String>
§include_empty: bool
§budget: Option<u32>
§session: Option<String>
§session_workspace: Option<PathBuf>
§

SheetPage

Fields

§file: PathBuf
§sheet: String
§start_row: Option<u32>
§page_size: Option<u32>
§columns: Option<Vec<String>>
§columns_by_header: Option<Vec<String>>
§include_formulas: Option<bool>
§include_styles: Option<bool>
§include_header: Option<bool>
§format: SheetPageFormatArg
§session: Option<String>
§session_workspace: Option<PathBuf>
§

ReadTable

Fields

§file: PathBuf
§sheet: Option<String>
§range: Option<String>
§table_name: Option<String>
§region_id: Option<u32>
§limit: Option<u32>
§offset: Option<u32>
§sample_mode: Option<TableSampleModeArg>
§filters_json: Option<String>
§filters_file: Option<PathBuf>
§table_format: Option<TableReadFormat>
§session: Option<String>
§session_workspace: Option<PathBuf>
§

FindValue

Fields

§file: PathBuf
§query: String
§sheet: Option<String>
§mode: Option<FindValueMode>
§label_direction: Option<LabelDirectionArg>
§session: Option<String>
§session_workspace: Option<PathBuf>
§

NamedRanges

Fields

§file: PathBuf
§sheet: Option<String>
§name_prefix: Option<String>
§session: Option<String>
§session_workspace: Option<PathBuf>
§

DefineName

Fields

§file: PathBuf
§name: String
§refers_to: String
§scope: Option<String>
§scope_sheet_name: Option<String>
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§

UpdateName

Fields

§file: PathBuf
§name: String
§refers_to: Option<String>
§scope: Option<String>
§scope_sheet_name: Option<String>
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§

DeleteName

Fields

§file: PathBuf
§name: String
§scope: Option<String>
§scope_sheet_name: Option<String>
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§

FindFormula

Fields

§file: PathBuf
§query: String
§sheet: Option<String>
§limit: Option<u32>
§offset: Option<u32>
§

ScanVolatiles

Fields

§file: PathBuf
§sheet: Option<String>
§limit: Option<u32>
§offset: Option<u32>
§formula_parse_policy: Option<FormulaParsePolicy>
§

SheetStatistics

Fields

§file: PathBuf
§sheet: String
§

FormulaMap

Fields

§file: PathBuf
§sheet: String
§limit: Option<u32>
§sort_by: Option<FormulaSort>
§formula_parse_policy: Option<FormulaParsePolicy>
§

FormulaTrace

Fields

§file: PathBuf
§sheet: String
§cell: String
§direction: TraceDirectionArg
§depth: Option<u32>
§page_size: Option<usize>
§cursor_depth: Option<u32>
§cursor_offset: Option<usize>
§formula_parse_policy: Option<FormulaParsePolicy>
§session: Option<String>
§session_workspace: Option<PathBuf>
§

Describe

Fields

§file: PathBuf
§session: Option<String>
§session_workspace: Option<PathBuf>
§

TableProfile

Fields

§file: PathBuf
§sheet: Option<String>
§session: Option<String>
§session_workspace: Option<PathBuf>
§

LayoutPage

Fields

§file: PathBuf
§sheet: String
§range_positional: Option<String>
§range: Option<String>
§mode: Option<LayoutModeArg>
§max_col_width: Option<u32>
§fit_columns: bool
§skip_empty_columns_trim: bool
§render: Option<LayoutRenderArg>
§session: Option<String>
§session_workspace: Option<PathBuf>
§

CreateWorkbook

Fields

§path: PathBuf
§sheets: Option<Vec<String>>
§overwrite: bool
§

Copy

Fields

§source: PathBuf
§dest: PathBuf
§

Edit

Fields

§file: PathBuf
§sheet: String
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§edits: Vec<String>
§edits_file: Option<PathBuf>
§formula_parse_policy: Option<FormulaParsePolicy>
§

AppendRegion

Fields

§file: PathBuf
§sheet_name: String
§region_id: Option<u32>
§table_name: Option<String>
§rows: Option<String>
§from_csv: Option<String>
§header: bool
§footer_policy: AppendRegionFooterPolicyArg
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§

CloneTemplateRow

Fields

§file: PathBuf
§sheet_name: String
§source_row: u32
§before: Option<u32>
§after: Option<u32>
§insert_at: Option<u32>
§count: u32
§expand_adjacent_sums: bool
§patch_targets: ClonePatchTargetsArg
§merge_policy: CloneMergePolicyArg
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§

CloneRowBand

Fields

§file: PathBuf
§sheet_name: String
§source_rows: String
§before: Option<u32>
§after: Option<u32>
§insert_at: Option<u32>
§repeat: u32
§expand_adjacent_sums: bool
§patch_targets: ClonePatchTargetsArg
§merge_policy: CloneMergePolicyArg
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§

TransformBatch

Fields

§file: Option<PathBuf>
§ops: Option<String>
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§print_schema: bool
§formula_parse_policy: Option<FormulaParsePolicy>
§

StyleBatch

Fields

§file: Option<PathBuf>
§ops: Option<String>
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§print_schema: bool
§

ApplyFormulaPattern

Fields

§file: Option<PathBuf>
§ops: Option<String>
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§print_schema: bool
§

StructureBatch

Fields

§file: Option<PathBuf>
§ops: Option<String>
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§print_schema: bool
§formula_parse_policy: Option<FormulaParsePolicy>
§impact_report: bool
§show_formula_delta: bool
§

CheckRefImpact

Fields

§file: PathBuf
§ops: String
§show_formula_delta: bool
§

ColumnSizeBatch

Fields

§file: Option<PathBuf>
§ops: Option<String>
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§print_schema: bool
§

SheetLayoutBatch

Fields

§file: Option<PathBuf>
§ops: Option<String>
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§print_schema: bool
§

RulesBatch

Fields

§file: Option<PathBuf>
§ops: Option<String>
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§print_schema: bool
§formula_parse_policy: Option<FormulaParsePolicy>
§

Sheetport

Fields

§command: SheetportCommands
§

ReplaceInFormulas

Fields

§file: PathBuf
§sheet: String
§find: String
§replace: String
§range: Option<String>
§regex: bool
§case_sensitive: Option<bool>
§dry_run: bool
§in_place: bool
§output: Option<PathBuf>
§force: bool
§formula_parse_policy: Option<FormulaParsePolicy>
§

Recalculate

Fields

§file: PathBuf
§output: Option<PathBuf>
§force: bool
§ignore_sheets: Option<Vec<String>>
§changed_cells: bool
§

Verify

Fields

§baseline: PathBuf
§current: PathBuf
§targets: Option<Vec<String>>
§sheet_name: Option<String>
§named_ranges: bool
§errors_only: bool
§targets_only: bool
§

Diff

Fields

§original: PathBuf
§modified: PathBuf
§sheet: Option<String>
§sheets: Option<Vec<String>>
§range: Option<String>
§details: bool
§exclude_recalc_result: bool
§limit: u32
§offset: u32
§

Schema

§

Example

§

Session(Box<SessionCommands>)

§

RunManifest

Fields

§file: PathBuf
§manifest: PathBuf
§inputs: Option<String>
§rng_seed: Option<u64>
§freeze_volatile: bool

Trait Implementations§

Source§

impl Debug for Commands

Source§

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

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

impl FromArgMatches for Commands

Source§

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

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

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Commands, 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 Commands

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> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more