Skip to main content

Commands

Enum Commands 

Source
pub enum Commands {
    Scan {
        paths: Vec<PathBuf>,
        config: PathBuf,
        format: OutputFormat,
        stdin: bool,
        filename: Option<String>,
        changed_only: bool,
        base: Option<String>,
        fix: bool,
        dry_run: bool,
    },
    Baseline {
        paths: Vec<PathBuf>,
        config: PathBuf,
        output: PathBuf,
    },
    Mcp {
        config: PathBuf,
    },
    Init {
        output: PathBuf,
        force: bool,
    },
    Ratchet {
        command: RatchetCommands,
    },
}

Variants§

§

Scan

Scan files for rule violations

Fields

§paths: Vec<PathBuf>

Paths to scan (files or directories)

§config: PathBuf

Path to baseline.toml config file

§format: OutputFormat

Output format

§stdin: bool

Read file content from stdin instead of disk

§filename: Option<String>

Filename to use for glob matching when using –stdin

§changed_only: bool

Only scan files changed relative to a base branch (requires git)

§base: Option<String>

Base ref for –changed-only (default: auto-detect from CI env or “main”)

§fix: bool

Apply fixes automatically

§dry_run: bool

Preview fixes without applying (requires –fix)

§

Baseline

Count current occurrences of ratchet patterns and write a baseline JSON file

Fields

§paths: Vec<PathBuf>

Paths to scan (files or directories)

§config: PathBuf

Path to baseline.toml config file

§output: PathBuf

Output file path for the baseline JSON

§

Mcp

Run as an MCP (Model Context Protocol) server over stdio

Fields

§config: PathBuf

Path to baseline.toml config file

§

Init

Generate a starter baseline.toml for your project

Fields

§output: PathBuf

Output file path for the generated config

§force: bool

Overwrite existing config file

§

Ratchet

Manage ratchet rules (add, tighten, import from baseline)

Fields

Trait Implementations§

Source§

impl FromArgMatches for Commands

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