Skip to content

Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows

Clarify squash command description and behavior

Maximilian Roosfc033d44fbf2
diff --git a/docs/content/step.md b/docs/content/step.md
index da449d636..7e1b611f5 100644
--- a/docs/content/step.md
+++ b/docs/content/step.md
@@ -67,7 +67,7 @@ Usage: wt step [OPTIONS] <COMMAND>
Commands:
commit Commit changes with LLM commit message
- squash Squash commits with LLM commit message
+ squash Squash commits down to target
push Push changes to local target branch
rebase Rebase onto target
post-create Run post-create hook
diff --git a/src/cli.rs b/src/cli.rs
index a8abdd246..cf989a0b8 100644
--- a/src/cli.rs
+++ b/src/cli.rs
@@ -534,6 +534,10 @@ wt config var clear marker --all
#[derive(Subcommand)]
pub enum StepCommand {
/// Commit changes with LLM commit message
+ ///
+ /// Stages working tree changes based on `--stage` and commits them.
+ /// Generates the commit message using an LLM. Runs pre-commit hooks
+ /// unless `--no-verify` is passed.
Commit {
/// Skip approval prompts
#[arg(short, long)]
@@ -548,7 +552,12 @@ pub enum StepCommand {
stage: Option<crate::commands::commit::StageMode>,
},
- /// Squash commits with LLM commit message
+ /// Squash commits down to target
+ ///
+ /// Combines all commits since diverging from the target branch into a single
+ /// commit. Stages and includes working tree changes based on `--stage`.
+ /// Generates the commit message using an LLM. Runs pre-commit hooks
+ /// unless `--no-verify` is passed.
Squash {
/// Target branch
///
diff --git a/tests/snapshots/integration__integration_tests__help__help_step_long.snap b/tests/snapshots/integration__integration_tests__help__help_step_long.snap
index 96cd3a990..ec0a1dde1 100644
--- a/tests/snapshots/integration__integration_tests__help__help_step_long.snap
+++ b/tests/snapshots/integration__integration_tests__help__help_step_long.snap
@@ -22,7 +22,7 @@ Usage: wt step [OPTIONS] <COMMAND>
Commands:
commit Commit changes with LLM commit message
- squash Squash commits with LLM commit message
+ squash Squash commits down to target
push Push changes to local target branch
rebase Rebase onto target
post-create Run post-create hook
diff --git a/tests/snapshots/integration__integration_tests__help__help_step_short.snap b/tests/snapshots/integration__integration_tests__help__help_step_short.snap
index 4ea6acf37..387b80c86 100644
--- a/tests/snapshots/integration__integration_tests__help__help_step_short.snap
+++ b/tests/snapshots/integration__integration_tests__help__help_step_short.snap
@@ -22,7 +22,7 @@ Usage: wt step [OPTIONS] <COMMAND>
Commands:
commit Commit changes with LLM commit message
- squash Squash commits with LLM commit message
+ squash Squash commits down to target
push Push changes to local target branch
rebase Rebase onto target
post-create Run post-create hook