Expand description
CLI command implementations
Each command is implemented as a separate module for maintainability. All commands follow the same pattern:
- Define Args struct with clap derive
- Implement run() function that calls tldr-core
- Return Result<(), anyhow::Error>
Re-exports§
pub use calls::CallsArgs;pub use dead::DeadArgs;pub use impact::ImpactArgs;pub use structure::StructureArgs;pub use tree::TreeArgs;pub use change_impact::ChangeImpactArgs;pub use churn::ChurnArgs;pub use clones::ClonesArgs;pub use complexity::ComplexityArgs;pub use context::ContextArgs;pub use debt::DebtArgs;pub use deps::DepsArgs;pub use detect_patterns::PatternsArgs;pub use diagnostics::DiagnosticsArgs;pub use dice::DiceArgs;pub use doctor::DoctorArgs;pub use extract::ExtractArgs;pub use health::HealthArgs;pub use hubs::HubsArgs;pub use importers::ImportersArgs;pub use imports::ImportsArgs;pub use inheritance::InheritanceArgs;pub use references::ReferencesArgs;pub use search::SmartSearchArgs;pub use slice::SliceArgs;pub use smells::SmellsArgs;pub use whatbreaks::WhatbreaksArgs;pub use available::AvailableArgs;pub use reaching_defs::ReachingDefsArgs;pub use taint::TaintArgs;pub use cognitive::CognitiveArgs;pub use coverage::CoverageArgs;pub use halstead::HalsteadArgs;pub use hotspots::HotspotsArgs;pub use loc::LocArgs;pub use daemon::DaemonNotifyArgs;pub use daemon::DaemonQueryArgs;pub use daemon::DaemonStartArgs;pub use daemon::DaemonStatusArgs;pub use daemon::DaemonStopArgs;pub use daemon::CacheClearArgs;pub use daemon::CacheStatsArgs;pub use daemon::StatsArgs;pub use daemon::WarmArgs;pub use daemon_router::is_daemon_running;pub use daemon_router::params_for_dead;pub use daemon_router::params_with_entry_depth;pub use daemon_router::params_with_file;pub use daemon_router::params_with_file_function;pub use daemon_router::params_with_file_function_line;pub use daemon_router::params_with_func_depth;pub use daemon_router::params_with_module;pub use daemon_router::params_with_path;pub use daemon_router::params_with_path_lang;pub use daemon_router::params_with_pattern;pub use daemon_router::try_daemon_route;pub use daemon_router::try_daemon_route_async;pub use api_surface::ApiSurfaceArgs;pub use contracts::ChopArgs;pub use contracts::ChopResult;pub use contracts::Condition;pub use contracts::Confidence;pub use contracts::ContractsArgs;pub use contracts::ContractsError;pub use contracts::ContractsReport;pub use contracts::ContractsResult;pub use contracts::CoverageInfo;pub use contracts::DeadStore;pub use contracts::DeadStoresArgs;pub use contracts::DeadStoresReport;pub use contracts::ExceptionSpec;pub use contracts::FunctionInvariants;pub use contracts::FunctionSpecs;pub use contracts::InputOutputSpec;pub use contracts::Interval;pub use contracts::IntervalWarning;pub use contracts::Invariant;pub use contracts::InvariantKind;pub use contracts::InvariantsArgs;pub use contracts::InvariantsReport;pub use contracts::InvariantsSummary;pub use contracts::OutputFormat;pub use contracts::PropertySpec;pub use contracts::SpecsArgs;pub use contracts::SpecsByType;pub use contracts::SpecsReport;pub use contracts::SpecsSummary;pub use contracts::SubAnalysisResult;pub use contracts::VerifyArgs;pub use contracts::VerifyReport;pub use contracts::VerifySummary;pub use remaining::APICheckReport;pub use remaining::APICheckSummary;pub use remaining::APIRule;pub use remaining::ASTChange;pub use remaining::BaseChanges;pub use remaining::CallInfo;pub use remaining::ChangeType;pub use remaining::ComplexityInfo;pub use remaining::CycleDetector;pub use remaining::DefinitionResult;pub use remaining::DiffGranularity;pub use remaining::DiffReport;pub use remaining::DiffSummary;pub use remaining::ExplainReport;pub use remaining::Location;pub use remaining::MisuseCategory;pub use remaining::MisuseFinding;pub use remaining::MisuseSeverity;pub use remaining::NodeKind;pub use remaining::ParamInfo;pub use remaining::PurityInfo;pub use remaining::RemainingError;pub use remaining::RemainingResult;pub use remaining::SecureFinding;pub use remaining::SecureReport;pub use remaining::SecureSummary;pub use remaining::Severity;pub use remaining::SignatureInfo;pub use remaining::SymbolInfo;pub use remaining::SymbolKind;pub use remaining::TodoItem;pub use remaining::TodoReport;pub use remaining::TodoSummary;pub use remaining::TraversalResult;pub use remaining::DefinitionArgs;pub use remaining::DiffArgs;pub use remaining::ExplainArgs;pub use remaining::SecureArgs;pub use remaining::TodoArgs;pub use fix::FixArgs;pub use bugbot::BugbotCheckArgs;
Modules§
- api_
surface - API Surface command - Extract machine-readable API surface (structural contracts).
- available
- Available Expressions Analysis CLI command
- bugbot
- Bugbot command group - automated bug detection on code changes
- calls
- Calls command - Build call graph
- change_
impact - Change Impact command - Find tests affected by code changes
- churn
- Churn command - Git-based file churn analysis
- clones
- Clones command - Detect code clones in a codebase
- cognitive
- Cognitive complexity command - Calculate SonarQube cognitive complexity
- complexity
- Complexity command - Calculate function complexity metrics
- context
- Context command - Build LLM context
- contracts
- Contracts & Flow commands for TLDR CLI
- coverage
- Coverage command - Parse and report code coverage from existing reports
- daemon
- Daemon subsystem for TLDR CLI
- daemon_
router - Daemon Router - Auto-route CLI commands through daemon cache
- dead
- Dead command - Find dead code
- debt
- Debt command - Technical debt analysis using SQALE method
- deps
- Dependency Analysis command - Build and analyze import dependency graphs
- detect_
patterns - Patterns command - Detect design patterns and coding conventions
- diagnostics
- Diagnostics command - Unified type checking and linting across languages
- dice
- Dice command - Compare similarity between two code fragments
- doctor
- Doctor command - Check and install diagnostic tools
- extract
- Extract command - Extract complete module info from a file
- fix
- Fix command – diagnose and auto-fix errors from compiler/runtime output.
- halstead
- Halstead metrics command - Calculate Halstead complexity metrics per function
- health
- Health command - Comprehensive code health dashboard
- hotspots
- Hotspots command - Identify high-risk code regions
- hubs
- Hubs command - Detect high-centrality hub functions
- impact
- Impact command - Show impact analysis
- importers
- Importers command - Find all files that import a given module
- imports
- Imports command - Parse import statements from a file
- inheritance
- Inheritance command - Extract and visualize class hierarchies
- loc
- LOC command - Count lines of code with type breakdown
- patterns
- Pattern Analysis commands for TLDR CLI
- reaching_
defs - Reaching Definitions command - Display reaching definitions analysis
- references
- References command - Find all references to a symbol
- remaining
- Remaining commands for TLDR CLI
- search
- Smart Search command - Enriched BM25 search with structure + call graph context.
- slice
- Slice command - Program slicing
- smells
- Smells command - Detect code smells
- structure
- Structure command - Show code structure
- taint
- Taint analysis CLI command
- tree
- Tree command - Show file tree
- whatbreaks
- Whatbreaks command - unified impact analysis wrapper