Command

Enum Command 

Source
pub(crate) enum Command {
Show 31 variants Init { no_scan: bool, force_rescan: bool, text_index_max_bytes: Option<u64>, }, Map { json: bool, force: bool, }, Scan { path: PathBuf, text_index_max_bytes: Option<u64>, }, Overview, Folders { query: String, limit: usize, }, Files { query: Option<String>, folder: Option<String>, file_pattern: Option<String>, include_content: bool, limit: usize, }, Next { query: String, limit: usize, }, Outline { file: PathBuf, lines: usize, }, Summary { file: PathBuf, limit: usize, }, Search { pattern: String, retrieval_mode: SearchRetrievalModeArg, regex: bool, fuzzy: bool, case_sensitive: bool, file_pattern: Option<String>, context_lines: usize, start_index: usize, limit: usize, }, Slice { file: PathBuf, start_line: Option<usize>, end_line: Option<usize>, selector: OptionalSymbolSelectorArgs, }, Symbols { command: Box<SymbolsCommand>, }, Settings, Snapshot { action: SnapshotAction, path: PathBuf, require_digest: Option<String>, signing_key: Option<PathBuf>, trusted_public_key: Option<PathBuf>, }, ParserPack { storage_root: Option<PathBuf>, command: ParserPackCommand, }, Root { command: Option<RootCommand>, }, Config { print: bool, }, Ignore { command: IgnoreCommand, }, WatchStatus, Watch { path: PathBuf, once: bool, poll_seconds: u64, max_cycles: usize, max_workers: Option<usize>, timeout_seconds: Option<u64>, text_index_max_bytes: Option<u64>, }, HealthCheck {
Show 13 fields start_index: usize, limit: usize, category: Option<String>, severity: Option<HealthSeverityArg>, path_prefix: Option<String>, summary_only: bool, source_only: bool, coverage: bool, parser: Option<String>, provider: Option<String>, relation: Option<String>, coverage_state: Option<String>, reason: Option<String>,
}, Health { command: HealthCommand, }, Lint { strict_folders: bool, purpose_level: PurposeLintLevelArg, report_untracked: bool, strict_untracked: bool, }, Token { session: Option<String>, view: TokenView, trend: Option<TokenTrendWindow>, tokenizer: Option<String>, benchmark_results: Option<PathBuf>, theme: TokenTheme, }, Parity { command: Option<ParityCommand>, profile: String, }, StripLegacyPurpose { path: PathBuf, apply: bool, dry_run: bool, strip_source_headers: bool, }, ResetIndex { apply: bool, dry_run: bool, include_mcp_config: bool, }, Mcp { nearest_project: bool, }, McpConfig { server_name: String, harness: HarnessConfig, nearest_project: bool, }, RuntimeInfo, Purpose { command: PurposeCommand, },
}
Expand description

Supported ProjectAtlas CLI commands.

Variants§

§

Init

Initialize ProjectAtlas files in a repository.

Fields

§no_scan: bool

Create/verify the project surface without running the scan/index pipeline.

§force_rescan: bool

Run the scan/index phase even when a future freshness check could skip it.

§text_index_max_bytes: Option<u64>

Maximum UTF-8 file size persisted into SQLite text search during the init scan.

§

Map

Generate the ProjectAtlas TOON map.

Fields

§json: bool

Also write JSON next to the TOON map.

§force: bool

Run map generation even when CI environment variables are present.

§

Scan

Scan a repository and replace the durable index.

Fields

§path: PathBuf

Repository root to scan.

§text_index_max_bytes: Option<u64>

Maximum UTF-8 file size persisted into SQLite text search.

§

Overview

Print a repository overview.

§

Folders

Rank folders before inspecting files.

Fields

§query: String

Search query for path and purpose matching.

§limit: usize

Maximum number of folders to return.

§

Files

Rank files, optionally inside an already-selected folder.

Fields

§query: Option<String>

Search query for path and purpose matching.

§folder: Option<String>

Folder path to constrain the search.

§file_pattern: Option<String>

Optional repository-relative glob filter.

§include_content: bool

Include indexed file text as a bounded fallback ranking signal.

§limit: usize

Maximum number of files to return.

§

Next

Recommend the next indexed folders, files, and inspection commands.

Fields

§query: String

Task or navigation query.

§limit: usize

Maximum number of folders and files to return.

§

Outline

Build a compact outline for a chosen file.

Fields

§file: PathBuf

File path to outline.

§lines: usize

Number of non-empty preview lines to include.

§

Summary

Return structured deterministic file intelligence from the deep index.

Fields

§file: PathBuf

Repository-relative file path to summarize.

§limit: usize

Maximum rows per functions/methods/classes/types/calls section.

§

Search

Search indexed files with literal, regex, or fuzzy matching.

Fields

§pattern: String

Literal, regex, or fuzzy pattern to search for.

§retrieval_mode: SearchRetrievalModeArg

Retrieval family; lexical remains the default and always-available mode.

§regex: bool

Treat the pattern as a regex.

§fuzzy: bool

Treat the pattern as a fuzzy subsequence.

§case_sensitive: bool

Match case-sensitively.

§file_pattern: Option<String>

Optional repository-relative glob filter.

§context_lines: usize

Number of context lines before and after a match.

§start_index: usize

Pagination start index.

§limit: usize

Maximum matches to return.

§

Slice

Return an exact source line slice after a file has been selected.

Fields

§file: PathBuf

File path to slice.

§start_line: Option<usize>

One-based start line.

§end_line: Option<usize>

Optional one-based end line.

§selector: OptionalSymbolSelectorArgs

Optional exact declaration selector.

§

Symbols

Inspect and rebuild the ProjectAtlas symbol graph.

Fields

§command: Box<SymbolsCommand>

Symbol graph subcommand to run.

§

Settings

Print local ProjectAtlas settings and cache/index locations.

§

Snapshot

Export or import a portable derived-only graph snapshot.

Fields

§action: SnapshotAction

Snapshot operation.

§path: PathBuf

Destination archive for export or source archive for import.

§require_digest: Option<String>

Require this exact lowercase BLAKE3 digest during import.

§signing_key: Option<PathBuf>

Optional raw 32-byte Ed25519 secret key encoded as 64 hexadecimal characters.

§trusted_public_key: Option<PathBuf>

Require an import signature from this raw 32-byte Ed25519 public key.

§

ParserPack

Manage the separately shipped optional parser pack.

Fields

§storage_root: Option<PathBuf>

Override the user-owned pack storage root for isolated verification and tests.

§command: ParserPackCommand

Explicit lifecycle operation.

§

Root

Show, verify, or bind the project-local root.

Fields

§command: Option<RootCommand>

Root subcommand to run.

§

Config

Print the effective ProjectAtlas configuration.

Fields

§print: bool

Print the normalized configuration used by scan, map, lint, and watch.

§

Ignore

Manage the manual ProjectAtlas ignore layer in config.

Fields

§command: IgnoreCommand

Ignore subcommand to run.

§

WatchStatus

Print watcher availability and current status.

§

Watch

Watch a repository and refresh the index when files change.

Fields

§path: PathBuf

Repository root to watch.

§once: bool

Run one refresh pass and exit.

§poll_seconds: u64

Debounce interval in seconds for event mode and poll interval for fallback mode.

§max_cycles: usize

Maximum refresh cycles before exiting. Zero means no limit.

§max_workers: Option<usize>

Maximum parser worker threads during refresh.

§timeout_seconds: Option<u64>

Stop starting parser work after this many seconds during refresh.

§text_index_max_bytes: Option<u64>

Maximum UTF-8 file size persisted into SQLite text search.

§

HealthCheck

Report structural health findings.

Fields

§start_index: usize

Pagination start index after filters are applied.

§limit: usize

Maximum findings to return.

§category: Option<String>

Optional finding category filter.

§severity: Option<HealthSeverityArg>

Optional severity filter.

§path_prefix: Option<String>

Optional repository-relative primary or related path prefix.

§summary_only: bool

Return counts and paging metadata without finding rows.

§source_only: bool

Restrict findings to source files and folders that contain source files.

§coverage: bool

Opt in to bounded current coverage discovery instead of structural findings.

§parser: Option<String>

Optional source parser coverage filter.

§provider: Option<String>

Optional derived-fact provider coverage filter.

§relation: Option<String>

Optional relationship-family coverage filter.

§coverage_state: Option<String>

Optional complete, partial, failed, ignored, oversized, quarantined, or stale filter.

§reason: Option<String>

Optional exact coverage reason filter.

§

Health

Resolve a deterministic health finding with agent rationale.

Fields

§command: HealthCommand

Health subcommand to run.

§

Lint

Validate database purpose metadata, untracked files, and structure drift.

Fields

§strict_folders: bool

Deprecated compatibility flag; database folder purpose linting uses --purpose-level.

§purpose_level: PurposeLintLevelArg

Purpose curation strictness for SQLite health linting.

§report_untracked: bool

Report non-source files not covered by source scanning.

§strict_untracked: bool

Fail when disallowed untracked files exist.

§

Token

Print estimated token savings for recorded funnel usage.

Fields

§session: Option<String>

Optional caller-visible compatibility-label filter.

§view: TokenView

Presentation mode for the token report.

§trend: Option<TokenTrendWindow>

Optional trend grouping window.

§tokenizer: Option<String>

Optional local tokenizer calibration for indexed UTF-8 files.

§benchmark_results: Option<PathBuf>

Optional repository-relative agent-navigation benchmark result.

§theme: TokenTheme

Color theme for the human terminal dashboard.

§

Parity

Check repository-intelligence parity readiness.

Fields

§command: Option<ParityCommand>

Parity subcommand to run.

§profile: String

Parity profile to evaluate when omitting the report subcommand.

§

StripLegacyPurpose

Dry-run or apply cleanup of legacy .purpose metadata files.

Fields

§path: PathBuf

Repository root to inspect.

§apply: bool

Remove legacy .purpose files.

§dry_run: bool

Preview cleanup without modifying files.

§strip_source_headers: bool

Also report conservative source Purpose header candidates.

§

ResetIndex

Preview or clear local runtime index/cache files.

Fields

§apply: bool

Remove runtime index/cache files. Without this flag the command previews only.

§dry_run: bool

Preview cleanup without modifying files.

§include_mcp_config: bool

Also remove generated project-local MCP config.

§

Mcp

Run the native ProjectAtlas MCP server over stdio.

Fields

§nearest_project: bool

Allow absolute path MCP calls to route to the nearest already-indexed ProjectAtlas root.

§

McpConfig

Print a project-local MCP configuration with absolute runtime paths.

Fields

§server_name: String

MCP server name to emit.

§harness: HarnessConfig

Harness-specific config shape to emit.

§nearest_project: bool

Include mcp --nearest-project in the generated server startup args.

§

RuntimeInfo

Print structured runtime identity and capability information.

§

Purpose

Manage purpose metadata stored in the durable index.

Fields

§command: PurposeCommand

Purpose subcommand to run.

Trait Implementations§

Source§

impl Debug for Command

Source§

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

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

impl FromArgMatches for Command

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 Command

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.

§

impl<T> Instrument for T

§

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

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

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

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

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,