Skip to content

Commit c844bab

Browse files
committed
docs(cli): fix help text to reflect estimate default and current features
1 parent 56deeee commit c844bab

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

crates/codelens/src/cli.rs

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ const STYLES: Styles = Styles::styled()
1616
#[command(
1717
name = "codelens",
1818
version,
19-
about = "High performance code analysis tool — stats, health scores, hotspots, and trends\n\n\
19+
about = "High performance code analysis tool — stats, health scores, hotspots, trends, and cost estimation\n\n\
2020
Author: Tiger <DropFan@Gmail.com>\n\
2121
GitHub: https://github.com/DropFan/codelens",
2222
styles = STYLES,
@@ -70,8 +70,9 @@ pub enum Command {
7070
- cocomo-basic: COCOMO I Basic (Boehm 1981)\n\
7171
- cocomo2: COCOMO II Post-Architecture (Boehm 2000)\n\
7272
- putnam: Putnam/SLIM Rayleigh curve model\n\
73-
- locomo: LOCOMO LLM Output Cost Model\n\n\
74-
All parameters are configurable. Shows per-language breakdown."
73+
- locomo: LOCOMO LLM Output Cost Model\n\
74+
- all: Run all models and show comparison table (default)\n\n\
75+
All parameters are configurable. Single model shows per-language breakdown."
7576
)]
7677
Estimate(EstimateArgs),
7778
}
@@ -134,11 +135,11 @@ pub struct TrendArgs {
134135

135136
#[derive(Args, Debug)]
136137
pub struct EstimateArgs {
137-
/// Directories to analyze.
138+
/// Directories to analyze (defaults to current directory).
138139
#[arg(default_value = ".")]
139140
pub paths: Vec<PathBuf>,
140141

141-
/// Estimation model.
142+
/// Estimation model (default: all models comparison).
142143
#[arg(long, value_enum, default_value = "all")]
143144
pub model: ModelArg,
144145

@@ -360,7 +361,8 @@ const EXAMPLES: &str = "\
360361
\x1b[1;36mcodelens trend --compare latest~2 latest\x1b[0m \x1b[2m# Compare specific snapshots\x1b[0m
361362
362363
\x1b[1;32mEstimate\x1b[0m \x1b[2m(cost estimation):\x1b[0m
363-
\x1b[1;36mcodelens estimate .\x1b[0m \x1b[2m# COCOMO Basic (default)\x1b[0m
364+
\x1b[1;36mcodelens estimate .\x1b[0m \x1b[2m# All models comparison (default)\x1b[0m
365+
\x1b[1;36mcodelens estimate . --model cocomo-basic\x1b[0m \x1b[2m# Single model with details\x1b[0m
364366
\x1b[1;36mcodelens estimate . --model cocomo2\x1b[0m \x1b[2m# COCOMO II model\x1b[0m
365367
\x1b[1;36mcodelens estimate . --model putnam --ck 11000\x1b[0m \x1b[2m# Putnam with custom Ck\x1b[0m
366368
\x1b[1;36mcodelens estimate . --model locomo\x1b[0m \x1b[2m# LLM generation cost\x1b[0m

0 commit comments

Comments
 (0)