update man-pages and help strings (#646)

tulioz · web-flow · commit 31760dad0a58 · 2026-01-15T22:30:31.000Z
This PR was created automatically by Aviator Runbooks. **Runbook URL**: https://app.aviator.co/r/159 **Executed by**: @tulioz <details> <summary>💡 Revise with Runbooks</summary> Use `/aviator revise` to address the feedback provided on this PR: **As a PR comment:** - `/aviator revise` - Process all unresolved review comments on the PR - `/aviator revise [instructions]` - Process any unresolved comments and handle additional instructions. **As a review comment:** - Reply with `/aviator revise [instructions]` to an existing review comment to address that specific thread - Post `/aviator revise [instructions]` as a review comment to have Runbooks revise that code section based on given instructions. [Read the complete guide with examples](https://docs.aviator.co/runbooks/how-to-guides/providing-feedback) </details> ## Steps **Included in this PR** - 1.1 Create av-squash.1.md and update av.1.md - 2.1 Add OPTIONS section to av.1.md with global flags - 2.2 Add missing flags to av-adopt.1.md and av-tree.1.md - 3.1 Add SYNOPSIS sections to av-init.1.md, av-pr-status.1.md, and av-split-commit.1.md - 4.1 Update av-auth.1.md and av-reorder.1.md descriptions - 4.2 Remove --submit flag reference from av-pr.1.md <details> <summary>View all Runbook steps (6 of 6 complete)</summary> 1. **Create av-squash Man Page and Update Main Man Page** - 1.1 Create av-squash.1.md and update av.1.md 👈 2. **Add Missing Flags and OPTIONS Sections** - 2.1 Add OPTIONS section to av.1.md with global flags 👈 - 2.2 Add missing flags to av-adopt.1.md and av-tree.1.md 👈 3. **Add Missing SYNOPSIS Sections** - 3.1 Add SYNOPSIS sections to av-init.1.md, av-pr-status.1.md, and av-split-commit.1.md 👈 4. **Fix Description Mismatches and Remove Invalid Documentation** - 4.1 Update av-auth.1.md and av-reorder.1.md descriptions 👈 - 4.2 Remove --submit flag reference from av-pr.1.md 👈 </details>
diff --git a/docs/av-adopt.1.md b/docs/av-adopt.1.md
@@ -7,7 +7,7 @@ av-adopt - Adopt branches that are not managed by `av`
 ## SYNOPSIS
 
 ```synopsis
-av adopt [--parent=<parent> | --remote=<branch>]
+av adopt [--dry-run] [--parent=<parent> | --remote=<branch>]
 ```
 
 ## DESCRIPTION
@@ -48,6 +48,9 @@ it along with its parent branches.
 `--parent=<parent>`
 : Force specify the parent branch.
 
+`--dry-run`
+: Show what branches would be adopted without actually adopting them.
+
 `--remote=<branch>`
 : Specify a remote branch to adopt from.
 
diff --git a/docs/av-auth.1.md b/docs/av-auth.1.md
@@ -2,7 +2,7 @@
 
 ## NAME
 
-av-auth - Show info about the logged in user
+av-auth - Check user authentication status
 
 ## SYNOPSIS
 
diff --git a/docs/av-init.1.md b/docs/av-init.1.md
@@ -4,6 +4,12 @@
 
 av-init - Initialize the repository for `av`
 
+## SYNOPSIS
+
+```synopsis
+av init
+```
+
 ## DESCRIPTION
 
 `av` internally stores metadata in the repository. This command initializes the
diff --git a/docs/av-pr-status.1.md b/docs/av-pr-status.1.md
@@ -4,6 +4,12 @@
 
 av-pr-status - Get the status of the associated pull request.
 
+## SYNOPSIS
+
+```synopsis
+av pr status
+```
+
 ## DESCRIPTION
 
 Gets the status of the current branch's associated pull request. Also includes
diff --git a/docs/av-pr.1.md b/docs/av-pr.1.md
@@ -7,9 +7,9 @@ av-pr - Create a pull request for the current branch
 ## SYNOPSIS
 
 ```synopsis
-av pr create [-t <title>| --title=<title>] [-b <body>| --body=<body>]
+av pr [-t <title>| --title=<title>] [-b <body>| --body=<body>]
     [--draft] [--edit] [--force] [--no-push] [--reviewers=<reviewers>]
-    [--submit] [--current] [--queue]
+    [--all [--current]] [--queue]
 ```
 
 ## DESCRIPTION
diff --git a/docs/av-reorder.1.md b/docs/av-reorder.1.md
@@ -15,8 +15,8 @@ av reorder [--continue | --abort]
 This is analogous to git rebase --interactive but operates across all branches
 in the stack.
 
-Branches can be re-arranged within the stack and commits can be dropped, or
-moved within the stack, even across the branches.
+Branches can be re-arranged within the stack and commits can be edited,
+squashed, dropped, or moved within the stack, even across the branches.
 
 ## OPTIONS
 
diff --git a/docs/av-split-commit.1.md b/docs/av-split-commit.1.md
@@ -4,6 +4,12 @@
 
 av-split-commit - Split a commit into multiple commits
 
+## SYNOPSIS
+
+```synopsis
+av split-commit
+```
+
 ## DESCRIPTION
 
 Split the currently checked out commit into multiple commits. When invoked, it
diff --git a/docs/av-squash.1.md b/docs/av-squash.1.md
@@ -0,0 +1,37 @@
+# av-squash
+
+## NAME
+
+av-squash - Squash commits of the current branch into a single commit
+
+## SYNOPSIS
+
+```synopsis
+av squash
+```
+
+## DESCRIPTION
+
+Squash all commits on the current branch into a single commit. This command
+performs a soft reset to the first commit on the branch (relative to the parent
+branch) and then amends that commit with all subsequent changes, effectively
+combining all commits into one.
+
+This command requires a clean working directory and will not work on branches
+that have already been merged. The branch must have at least two commits to
+squash.
+
+After squashing, **av squash** automatically runs **av restack** to rebase
+any child branches on the newly squashed commit.
+
+## EXAMPLES
+
+Squash all commits on the current branch:
+
+```bash
+$ av squash
+```
+
+## SEE ALSO
+
+`av-commit`(1), `av-restack`(1)
diff --git a/docs/av-tree.1.md b/docs/av-tree.1.md
@@ -7,9 +7,14 @@ av-tree - Show the tree of stacked branches
 ## SYNOPSIS
 
 ```synopsis
-av tree
+av tree [--current]
 ```
 
 ## DESCRIPTION
 
 Show the tree of stacked branches.
+
+## OPTIONS
+
+`--current`
+: Show only the current stack (current branch and its ancestors/descendants).
diff --git a/docs/av.1.md b/docs/av.1.md
@@ -26,12 +26,21 @@ av - Aviator CLI
 - av-reparent(1): Change the parent of the current branch
 - av-restack(1): Rebase the stacked branches
 - av-split-commit(1): Split a commit into multiple commits
+- av-squash(1): Squash commits of the current branch into a single commit
 - av-switch(1): Interactively switch to a different branch
 - av-sync(1): Synchronize stacked branches with GitHub
 - av-sync-exclude(1): Toggle branch exclusion from sync --all operations
 - av-tidy(1): Tidy stacked branches
 - av-tree(1): Show the tree of stacked branches
 
+## OPTIONS
+
+`--debug`
+: Enable verbose debug logging.
+
+`-C <directory>`, `--repo=<directory>`
+: Directory to use for git repository.
+
 ## FURTHER DOCUMENTATION
 
 See [Aviator documentation](https://docs.aviator.co) for the help document
