Skip to main content

ScanArgs

Struct ScanArgs 

Source
pub struct ScanArgs {
Show 43 fields pub mode: OutputMode, pub find: Option<String>, pub filter_type: Option<String>, pub entry_type: Option<String>, pub min_size: Option<String>, pub max_size: Option<String>, pub newer_than: Option<String>, pub older_than: Option<String>, pub depth: usize, pub no_ignore: bool, pub no_default_ignore: bool, pub all: bool, pub show_ignored: bool, pub everything: bool, pub smart: bool, pub changes_only: bool, pub min_interest: f32, pub no_security: bool, pub show_filesystems: bool, pub no_emoji: bool, pub compress: bool, pub mcp_optimize: bool, pub compact: bool, pub path_mode: PathMode, pub color: ColorMode, pub ai_json: bool, pub stream: bool, pub sse_server: bool, pub sse_port: u16, pub search: Option<String>, pub semantic: bool, pub focus: Option<PathBuf>, pub relations_filter: Option<String>, pub sort: Option<SortField>, pub top: Option<usize>, pub mermaid_style: MermaidStyleArg, pub no_markdown_mermaid: bool, pub no_markdown_tables: bool, pub no_markdown_pie_charts: bool, pub index_registry: Option<String>, pub show_private: bool, pub view_diffs: bool, pub cleanup_diffs: Option<usize>,
}

Fields§

§mode: OutputMode

Output format (classic, ai, quantum, json, etc.)

§find: Option<String>

Find files matching regex pattern (e.g., –find “README.md”)

§filter_type: Option<String>

Filter by file extension (e.g., –type rs)

§entry_type: Option<String>

Filter by entry type: f (files) or d (directories)

§min_size: Option<String>

Only files larger than size (e.g., –min-size 1M)

§max_size: Option<String>

Only files smaller than size (e.g., –max-size 100K)

§newer_than: Option<String>

Files newer than date (YYYY-MM-DD)

§older_than: Option<String>

Files older than date (YYYY-MM-DD)

§depth: usize

Traversal depth (0 = auto, 1 = shallow, 10 = deep)

§no_ignore: bool

Ignore .gitignore files

§no_default_ignore: bool

Ignore default patterns (node_modules, pycache, etc.)

§all: bool

Show hidden files (starting with .)

§show_ignored: bool

Show ignored directories in brackets

§everything: bool

Show EVERYTHING (–all + –no-ignore + –no-default-ignore)

§smart: bool

Enable smart mode - surface what matters, not everything Groups output by interest: security, changes, important, background

§changes_only: bool

Only show changes since last scan

§min_interest: f32

Minimum interest level (0.0-1.0) to display

§no_security: bool

Disable security scanning during traversal

§show_filesystems: bool

Show filesystem type indicators (X=XFS, 4=ext4, B=Btrfs)

§no_emoji: bool

Disable emojis (Trish will miss them!)

§compress: bool

Compress output with zlib (base64 encoded)

§mcp_optimize: bool

Optimize for MCP/API (compression + no colors/emoji)

§compact: bool

Compact JSON (single line)

§path_mode: PathMode

Path display: off, relative, or full

§color: ColorMode

Color output: always, never, or auto

§ai_json: bool

Wrap AI output in JSON structure

§stream: bool

Stream output as files are scanned

§sse_server: bool

Start SSE server for real-time monitoring

§sse_port: u16

SSE server port (also used as daemon port)

§search: Option<String>

Search file contents (e.g., –search “TODO”)

§semantic: bool

Group by semantic similarity

§focus: Option<PathBuf>

Focus analysis on specific file (relations mode)

§relations_filter: Option<String>

Filter relationships: imports, calls, types, tests, coupled

§sort: Option<SortField>

Sort by: a-to-z, z-to-a, largest, smallest, newest, oldest, type

§top: Option<usize>

Show only top N results (use with –sort)

§mermaid_style: MermaidStyleArg

Mermaid style: flowchart, mindmap, gitgraph, treemap

§no_markdown_mermaid: bool

Exclude mermaid diagrams from markdown

§no_markdown_tables: bool

Exclude tables from markdown

§no_markdown_pie_charts: bool

Exclude pie charts from markdown

§index_registry: Option<String>

Index code to SmartPastCode registry

§show_private: bool

Show private functions in docs (function-markdown mode)

§view_diffs: bool

View Smart Edit diffs from .st folder

§cleanup_diffs: Option<usize>

Clean up old diffs, keep last N per file

Trait Implementations§

Source§

impl Args for ScanArgs

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

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

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

fn augment_args_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§

impl CommandFactory for ScanArgs

Source§

fn command<'b>() -> Command

Build a Command that can instantiate Self. Read more
Source§

fn command_for_update<'b>() -> Command

Build a Command that can update self. Read more
Source§

impl Debug for ScanArgs

Source§

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

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

impl FromArgMatches for ScanArgs

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( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Parser for ScanArgs

Source§

fn parse() -> Self

Parse from std::env::args_os(), exit on error.
Source§

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.
Source§

fn parse_from<I, T>(itr: I) -> Self
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.
Source§

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.
Source§

fn update_from<I, T>(&mut self, itr: I)
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error. Read more
Source§

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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
Source§

impl<T> ErasedDestructor for T
where T: 'static,