cherrypick-interactive 1.13.3 → 1.13.5

package/README.md

@@ -22,30 +22,6 @@ No manual `git log` diffing. No risky merges. No guesswork.
 
 ---
 
-## 🧭 What it does
-
-- 🔍 Finds commits in `dev` not present in `main`
-- 🗂️ Lets you select which commits to cherry-pick (or pick all)
-- 🪜 Cherry-picks in the correct order (oldest → newest)
-- ⚔️ **Interactive conflict resolution wizard** with multiple strategies
-- 🎯 **Preserves exact commit messages** from squashed commits
-- 🪄 Detects **semantic version bump** (`major`, `minor`, `patch`) from conventional commits
-- 🧩 Creates a `release/x.y.z` branch from `main`
-- 🧾 Generates a Markdown changelog from commits
-- 🔗 Links ticket IDs to your issue tracker (ClickUp, Jira, Linear, or custom)
-- 🖥️ Rich **TUI dashboard** with diff preview, search, and keyboard shortcuts
-- 🤖 **CI mode** for fully non-interactive pipeline execution
-- ↩️ **Undo / rollback** with checkpoint-based session recovery
-- 📋 **Changelog preview** before cherry-pick with confirmation gate
-- ⚠️ **Dependency detection** warns when selected commits depend on unselected ones
-- 💾 **Profiles** to save and reuse CLI flag combinations
-- 🧰 Optionally:
-    - updates `package.json` version
-    - commits and pushes it
-    - opens a **GitHub PR** (draft or normal)
-
----
-
 ## 📦 Installation
 
 ```bash
@@ -58,342 +34,47 @@ npm install -g cherrypick-interactive
 
 ## 🚀 Quick Start
 
-```bash
-cherrypick-interactive \
-  --semantic-versioning \
-  --version-file ./package.json \
-  --create-release \
-  --push-release \
-  --draft-pr
-```
-
-✅ This will:
-1. Fetch `origin/dev` and `origin/main`
-2. List commits in `dev` missing from `main`
-3. Let you select which to cherry-pick (TUI dashboard with diff preview)
-4. Detect potential dependencies between commits
-5. Show a changelog preview with version bump info
-6. Compute the next version from commit messages
-7. Create `release/<next-version>` from `main`
-8. Cherry-pick the selected commits (with conflict resolution if needed)
-9. Update your `package.json` version and commit it
-10. Push the branch and open a **draft PR** on GitHub
-
----
-
-## 🧩 Common Use Cases
-
-### 1. Compare branches manually
-
 ```bash
 cherrypick-interactive
 ```
 
-Lists commits in `origin/dev` that aren't in `origin/main`, filtered by the last week.
-
-### 2. Cherry-pick all missing commits automatically
-
-```bash
-cherrypick-interactive --all-yes
-```
-
-### 3. Preview changes without applying them
-
-```bash
-cherrypick-interactive --dry-run
-```
-
-### 4. Filter commits by pattern
-
-```bash
-cherrypick-interactive --ignore-commits "^chore\(deps\)|^ci:"
-```
-
-Excludes commits starting with `chore(deps)` or `ci:` from the selection list.
-
-### 5. Ignore certain commits from semantic versioning
-
-```bash
-cherrypick-interactive --ignore-semver "bump|dependencies"
-```
-
-Treats commits containing "bump" or "dependencies" as chores (no version bump).
-
-### 6. Use a saved profile
-
-```bash
-# Save your flags once
-cherrypick-interactive --save-profile hotfix --dev origin/develop --main origin/release --since "2 weeks ago"
-
-# Reuse anytime
-cherrypick-interactive --profile hotfix
-```
-
-### 7. Run in CI/CD pipeline
-
-```bash
-cherrypick-interactive --ci --conflict-strategy theirs --format json > result.json
-```
-
-### 8. Link ticket IDs in changelog
-
-```bash
-cherrypick-interactive --tracker clickup --tracker-url "https://app.clickup.com/t/{{id}}"
-```
-
-### 9. Undo the last cherry-pick session
-
-```bash
-cherrypick-interactive --undo
-```
-
----
-
-## ⚙️ Options
-
-### Cherry-pick options
-
-| Flag | Description | Default |
-|------|--------------|----------|
-| `--dev` | Source branch (commits to copy) | `origin/dev` |
-| `--main` | Target branch (commits already merged here will be skipped) | `origin/main` |
-| `--since` | Git time window filter (e.g. `"2 weeks ago"`) | `1 week ago` |
-| `--no-fetch` | Skip `git fetch --prune` | `false` |
-| `--all-yes` | Cherry-pick all missing commits without prompt | `false` |
-| `--ignore-commits` | Comma-separated regex patterns to exclude commits | — |
-
-### Version options
-
-| Flag | Description | Default |
-|------|--------------|----------|
-| `--semantic-versioning` | Detect semantic version bump from commits | `true` |
-| `--current-version` | Current version (if not reading from file) | — |
-| `--version-file` | Path to `package.json` (to read & update version) | `./package.json` |
-| `--version-commit-message` | Template for version bump commit | `chore(release): bump version to {{version}}` |
-| `--ignore-semver` | Comma-separated regex patterns to ignore for semver | — |
-
-### Release options
-
-| Flag | Description | Default |
-|------|--------------|----------|
-| `--create-release` | Create `release/x.y.z` branch from `main` | `true` |
-| `--push-release` | Push release branch to origin | `true` |
-| `--draft-pr` | Create the GitHub PR as a draft | `false` |
-
-### CI options
-
-| Flag | Description | Default |
-|------|--------------|----------|
-| `--ci` | Enable fully non-interactive mode | `false` |
-| `--conflict-strategy` | How to handle conflicts: `fail`, `ours`, `theirs`, `skip` | `fail` |
-| `--format` | Output format: `text` or `json` | `text` |
-| `--dependency-strategy` | How to handle dependencies: `warn`, `fail`, `ignore` | `warn` |
-
-### Tracker options
-
-| Flag | Description | Default |
-|------|--------------|----------|
-| `--tracker` | Built-in preset: `clickup`, `jira`, `linear` | — |
-| `--ticket-pattern` | Custom regex to capture ticket ID (one capture group) | — |
-| `--tracker-url` | URL template with `{{id}}` placeholder | — |
-
-### Profile options
-
-| Flag | Description | Default |
-|------|--------------|----------|
-| `--profile` | Load a named profile from `.cherrypickrc.json` | — |
-| `--save-profile` | Save current CLI flags as a named profile | — |
-| `--list-profiles` | List available profiles and exit | `false` |
-
-### Session options
-
-| Flag | Description | Default |
-|------|--------------|----------|
-| `--undo` | Reset release branch to pre-cherry-pick state | `false` |
-
-### UI options
-
-| Flag | Description | Default |
-|------|--------------|----------|
-| `--no-tui` | Disable TUI dashboard, use simple checkbox instead | `false` |
-| `--dry-run` | Show what would happen without applying changes | `false` |
-
----
-
-## 🧠 How Semantic Versioning Works
-
-The tool analyzes commit messages using **Conventional Commits**:
-
-| Prefix | Example | Bump |
-|---------|----------|------|
-| `BREAKING CHANGE:` | `feat(auth): BREAKING CHANGE: require MFA` | **major** |
-| `feat:` | `feat(ui): add dark mode` | **minor** |
-| `fix:` / `perf:` | `fix(api): correct pagination offset` | **patch** |
-
-Use `--ignore-semver` to treat certain commits as chores:
-
-```bash
-cherrypick-interactive --ignore-semver "^chore\(deps\)|bump|merge"
-```
-
----
-
-## ⚔️ Interactive Conflict Resolution
-
-When cherry-picking encounters conflicts, the tool provides an **interactive wizard**:
-
-### Conflict Resolution Options:
-
-**Per-file resolution:**
-- **Use ours** — Keep the current branch's version
-- **Use theirs** — Accept the cherry-picked commit's version
-- **Open in editor** — Manually resolve conflicts in your editor
-- **Show diff** — View the conflicting changes
-- **Mark resolved** — Stage the file as-is
-
-**Bulk actions:**
-- **Use ours for ALL** — Apply current branch's version to all conflicts
-- **Use theirs for ALL** — Accept cherry-picked version for all conflicts
-- **Stage ALL** — Mark all files as resolved
-- **Launch mergetool** — Use Git's configured merge tool
-
-In CI mode, `--conflict-strategy` handles conflicts automatically (`ours`, `theirs`, `skip`, or `fail`).
-
----
-
-## 🖥️ TUI Dashboard
-
-The commit selection screen features a rich terminal UI:
-
-- **Arrow keys / j/k** — Navigate commits
-- **Space** — Toggle selection
-- **a / n** — Select all / deselect all
-- **/** — Search/filter commits by message
-- **d** — Full diff overlay (Esc to return)
-- **p** — Toggle preview pane
-- **Enter** — Confirm selection
-- **q** — Quit (with confirmation if commits are selected)
-
-Each commit shows its hash, subject, and relative date. Selected commits are highlighted in green.
-
-Falls back to simple `inquirer` checkbox on: Windows, small terminals, CI, or with `--no-tui`.
-
----
-
-## 💾 Profiles
-
-Save and reuse CLI flag combinations:
-
-```bash
-# Save
-cherrypick-interactive --save-profile hotfix --dev origin/develop --main origin/release --since "2 weeks ago"
-
-# Use
-cherrypick-interactive --profile hotfix
-
-# Override a single flag
-cherrypick-interactive --profile hotfix --since "3 days ago"
-
-# List all profiles
-cherrypick-interactive --list-profiles
-```
-
-Config stored in `.cherrypickrc.json`:
-
-```json
-{
-  "profiles": {
-    "hotfix": {
-      "dev": "origin/develop",
-      "main": "origin/release",
-      "since": "2 weeks ago"
-    }
-  },
-  "tracker": {
-    "ticket-pattern": "#([a-z0-9]+)",
-    "tracker-url": "https://app.clickup.com/t/{{id}}"
-  }
-}
-```
-
----
-
-## 🔗 Tracker Integration
-
-Link ticket IDs in your changelog to your issue tracker:
+That's it. Compares `origin/dev` vs `origin/main` for the last week and lets you pick interactively.
 
-```bash
-# Built-in presets
-cherrypick-interactive --tracker clickup --tracker-url "https://app.clickup.com/t/{{id}}"
-cherrypick-interactive --tracker jira --tracker-url "https://team.atlassian.net/browse/{{id}}"
-cherrypick-interactive --tracker linear --tracker-url "https://linear.app/my-team/issue/{{id}}"
-
-# Custom pattern
-cherrypick-interactive --ticket-pattern "#([a-z0-9]+)" --tracker-url "https://app.clickup.com/t/{{id}}"
-```
-
-Commit `#86c8w62wx - Fix login bug` becomes `[#86c8w62wx](https://app.clickup.com/t/86c8w62wx) - Fix login bug` in the changelog.
+For a full release workflow, see the [Quick Start guide](docs/quick-start.md).
 
 ---
 
-## 🤖 CI Mode
-
-Run fully non-interactive in CI/CD pipelines:
-
-```bash
-cherrypick-interactive --ci --conflict-strategy theirs --format json > result.json
-```
-
-**Exit codes:**
-
-| Code | Meaning |
-|------|---------|
-| `0` | Success |
-| `1` | Conflict (with `--conflict-strategy fail`) |
-| `2` | No commits found |
-| `3` | Auth / push error |
-| `4` | Dependency issue (with `--dependency-strategy fail`) |
-
-**JSON output** goes to stdout, all logs go to stderr. Colors auto-disabled in JSON mode.
-
----
-
-## ↩️ Undo / Rollback
-
-Made a mistake? Roll back the entire cherry-pick session:
-
-```bash
-cherrypick-interactive --undo
-```
+## 🧭 What it does
 
-- Checkpoint saved automatically before each session
-- Validates branch integrity before reset (ancestor check + divergence detection)
-- Uses `--force-with-lease` (not `--force`)
-- Option to re-open commit selection after undo
+- 🔍 Finds commits in `dev` not present in `main`
+- 🗂️ Lets you select which commits to cherry-pick (or pick all)
+- 🪜 Cherry-picks in the correct order (oldest → newest)
+- ⚔️ [**Interactive conflict resolution wizard**](docs/conflict-resolution.md)
+- 🎯 **Preserves exact commit messages** from squashed commits
+- 🪄 Detects [**semantic version bump**](docs/semantic-versioning.md) from conventional commits
+- 🧩 Creates a `release/x.y.z` branch from `main`
+- 🧾 Generates a Markdown changelog with [**ticket linking**](docs/tracker-integration.md)
+- 🖥️ Rich [**TUI dashboard**](docs/tui-dashboard.md) with diff preview, search, and keyboard shortcuts
+- 🤖 [**CI mode**](docs/ci-mode.md) for fully non-interactive pipeline execution
+- ↩️ [**Undo / rollback**](docs/undo-rollback.md) with checkpoint-based session recovery
+- 💾 [**Profiles**](docs/profiles.md) to save and reuse CLI flag combinations
 
 ---
 
-## 🧹 Why This Helps
+## 📖 Documentation
 
-If your team:
-- Rebases or cherry-picks from `dev` → `main`
-- Uses temporary release branches
-- Works with squashed commits
-- Needs to handle merge conflicts gracefully
-- Tracks semantic versions via commits
-
-…this CLI saves time and reduces errors.
-It automates a tedious, error-prone manual process into a single command that behaves like `yarn upgrade-interactive`, but for Git commits.
-
-**Special features:**
-- ✅ Preserves exact commit messages (critical for squashed commits)
-- ✅ Interactive conflict resolution without leaving the terminal
-- ✅ Smart pattern-based filtering for commits and version detection
-- ✅ Automatic changelog generation with ticket linking
-- ✅ TUI dashboard with diff preview and keyboard shortcuts
-- ✅ CI mode with structured JSON output and distinct exit codes
-- ✅ Undo/rollback with safety checks
-- ✅ Reusable profiles for common workflows
+| Topic | Description |
+|-------|-------------|
+| [🚀 Quick Start](docs/quick-start.md) | Getting started, full workflow, custom branches |
+| [🧩 Common Use Cases](docs/common-use-cases.md) | Filtering, profiles, CI, tracker, undo, and more |
+| [⚙️ All Options](docs/options.md) | Complete reference for all CLI flags |
+| [⚔️ Conflict Resolution](docs/conflict-resolution.md) | Per-file and bulk resolution, CI strategies |
+| [🧠 Semantic Versioning](docs/semantic-versioning.md) | Conventional commits, version sources, ignore patterns |
+| [🖥️ TUI Dashboard](docs/tui-dashboard.md) | Keyboard shortcuts, diff preview, search, fallback |
+| [💾 Profiles](docs/profiles.md) | Save/load/list profiles, config file, CI usage |
+| [🔗 Tracker Integration](docs/tracker-integration.md) | ClickUp, Jira, Linear presets, custom patterns |
+| [🤖 CI Mode](docs/ci-mode.md) | Exit codes, JSON output, GitHub Actions example |
+| [↩️ Undo / Rollback](docs/undo-rollback.md) | Checkpoint system, safety checks, limitations |
 
 ---
 
@@ -402,59 +83,6 @@ It automates a tedious, error-prone manual process into a single command that be
 - Node.js ≥ 20
 - Git ≥ 2.0
 - **GitHub CLI (`gh`)** — *Optional, only required if using `--push-release`*
-    - Install from: https://cli.github.com/
-    - The tool will check if `gh` is installed and offer to continue without it
-- A clean working directory (no uncommitted changes)
-
----
-
-## 🎯 Best Practices
-
-### 1. Use `--ignore-commits` to filter noise
-
-```bash
-cherrypick-interactive --ignore-commits "^ci:|^chore\(deps\):|Merge branch"
-```
-
-Exclude CI updates, dependency bumps, and merge commits from selection.
-
-### 2. Use `--ignore-semver` for version accuracy
-
-```bash
-cherrypick-interactive --ignore-semver "bump|dependencies|merge"
-```
-
-Prevent certain commits from affecting semantic version calculation.
-
-### 3. Always use `--draft-pr` for review
-
-```bash
-cherrypick-interactive --draft-pr
-```
-
-Creates draft PRs so your team can review before merging.
-
-### 4. Test with `--dry-run` first
-
-```bash
-cherrypick-interactive --dry-run
-```
-
-See what would happen without making any changes.
-
-### 5. Save your workflow as a profile
-
-```bash
-cherrypick-interactive --save-profile release --dev origin/dev --main origin/main --since "1 month ago" --draft-pr
-```
-
-Then just run `cherrypick-interactive --profile release` every time.
-
----
-
-## 🧾 License
-
-**MIT** — free to use, modify, and distribute.
 
 ---
 
@@ -462,56 +90,15 @@ Then just run `cherrypick-interactive --profile release` every time.
 
 1. Clone the repo
 2. Install dependencies: `yarn install`
-3. Run locally:
-   ```bash
-   node cli.js --dry-run
-   ```
-4. Run tests:
-   ```bash
-   yarn test
-   ```
-5. Test edge cases before submitting PRs:
-    - Squashed commits with conflicts
-    - Empty cherry-picks
-    - Multiple conflict resolutions
-6. Please follow Conventional Commits for your changes.
+3. Run locally: `node cli.js --dry-run`
+4. Run tests: `yarn test`
+5. Follow Conventional Commits for your changes.
 
 ---
 
-## 🐛 Troubleshooting
-
-### "GitHub CLI (gh) is not installed"
-The tool automatically checks for `gh` CLI when using `--push-release`. If not found, you'll be prompted to:
-- Install it from https://cli.github.com/ and try again
-- Or continue without creating a PR (the release branch will still be pushed)
-
-You can also run without `--push-release` to skip PR creation entirely:
-```bash
-cherrypick-interactive --create-release --no-push-release
-```
-
-### "Cherry-pick has conflicts"
-Use the interactive wizard to resolve conflicts file-by-file or in bulk. In CI, use `--conflict-strategy`.
-
-### "Commit message changed after conflict resolution"
-This issue has been fixed! The tool now preserves the original commit message using `git commit -C <hash>`.
-
-### "Version not detected correctly"
-Use `--ignore-semver` to exclude commits that shouldn't affect versioning:
-```bash
-cherrypick-interactive --ignore-semver "bump|chore\(deps\)"
-```
-
-### "Too many commits to review"
-Use `--ignore-commits` to filter out noise, or adjust `--since` to a shorter time window:
-```bash
-cherrypick-interactive --since "3 days ago" --ignore-commits "^ci:|^docs:"
-```
+## 🧾 License
 
-### "Want to undo a cherry-pick session"
-```bash
-cherrypick-interactive --undo
-```
+**MIT** — free to use, modify, and distribute.
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cherrypick-interactive",
-  "version": "1.13.3",
+  "version": "1.13.5",
   "description": "Interactively cherry-pick commits that are in dev but not in main, using subject-based comparison.",
   "main": "cli.js",
   "bin": "cli.js",