gut-cli 0.1.4 → 0.1.6

package/README.md

@@ -17,8 +17,9 @@ All AI commands support short aliases (without `ai-` prefix):
 | `gut ai-commit` | `gut commit` | Generate commit messages |
 | `gut ai-pr` | `gut pr` | Generate PR descriptions |
 | `gut ai-review` | `gut review` | Code review |
-| `gut ai-diff` | `gut diff` | Explain changes |
 | `gut ai-merge` | `gut merge` | Resolve merge conflicts |
+| `gut ai-explain` | `gut explain` | Explain changes, commits, PRs, or files |
+| `gut ai-find` | `gut find` | Find commits by vague description |
 | `gut changelog` | - | Generate changelogs |
 
 ### `gut commit`
@@ -86,39 +87,86 @@ gut review 123
 gut review --json
 ```
 
-### `gut diff`
+### `gut merge`
 
-Get an AI-powered explanation of your changes.
+Merge branches with AI-powered conflict resolution.
 
 ```bash
-# Explain all uncommitted changes
-gut diff
+# Merge a branch with AI conflict resolution
+gut merge feature/login
+
+# Use specific provider
+gut merge feature/login --provider openai
+
+# Don't auto-commit after resolving
+gut merge feature/login --no-commit
+```
+
+### `gut explain`
+
+Get AI-powered explanations of changes, commits, PRs, or file contents.
+
+```bash
+# Explain uncommitted changes (default)
+gut explain
 
 # Explain staged changes only
-gut diff --staged
+gut explain --staged
+
+# Explain a specific commit
+gut explain abc123
+gut explain HEAD
+
+# Explain a PR (requires gh CLI)
+gut explain 123
+gut explain #123
 
-# Explain specific commit
-gut diff --commit abc123
+# Explain a file's purpose and contents
+gut explain src/index.ts
+
+# Explain file's recent change history
+gut explain src/index.ts --history
+
+# Explain multiple recent commits for a file
+gut explain src/index.ts --history -n 5
 
 # Output as JSON
-gut diff --json
+gut explain --json
 ```
 
-### `gut merge`
+**Project Context Support**: Create `.gut/explain.md` to provide project-specific context for better explanations.
 
-Merge branches with AI-powered conflict resolution.
+### `gut find`
+
+Find commits matching a vague description using AI.
 
 ```bash
-# Merge a branch with AI conflict resolution
-gut merge feature/login
+# Find commits related to a feature
+gut find "login feature"
 
-# Use specific provider
-gut merge feature/login --provider openai
+# Find bug fixes
+gut find "fixed the crash"
 
-# Don't auto-commit after resolving
-gut merge feature/login --no-commit
+# Search with filters
+gut find "API changes" --author "John" --since "2024-01-01"
+
+# Limit search scope
+gut find "refactoring" --path src/lib --num 50
+
+# Output as JSON
+gut find "authentication" --json
 ```
 
+**Options:**
+- `-n, --num <n>` - Number of commits to search (default: 100)
+- `--path <path>` - Limit to commits affecting this path
+- `--author <author>` - Limit to commits by this author
+- `--since <date>` - Limit to commits after this date
+- `--until <date>` - Limit to commits before this date
+- `--max-results <n>` - Max matching commits to return (default: 5)
+
+**Project Context Support**: Create `.gut/find.md` to provide project-specific context for better search results.
+
 ### `gut changelog`
 
 Generate a changelog from commits.
@@ -189,6 +237,8 @@ gut looks for these configuration files in your repository:
 | `.gut/pr-template.md` | PR description template |
 | `.gut/changelog-template.md` | Changelog style template |
 | `.gut/merge-strategy.md` | Merge conflict resolution rules |
+| `.gut/explain.md` | Project context for explanations |
+| `.gut/find.md` | Project context for commit search |
 | `.github/pull_request_template.md` | PR template (fallback) |
 | `CHANGELOG.md` | Changelog style (fallback) |