Skip to content

Commit 30bb095

Browse files
committed
Update README for GitPilot 2.0 features
Revamps the README to highlight new features in GitPilot 2.0, including visual Git graphs, AI-powered conflict resolution, repository health monitoring, semantic commit search, and advanced analytics. Adds detailed documentation for new command-line interface options and specialized commands.
1 parent 8551898 commit 30bb095

File tree

1 file changed

+62
-26
lines changed

1 file changed

+62
-26
lines changed

README.md

Lines changed: 62 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
1-
# GitPilot
1+
# GitPilot 2.0
22

3-
**GitPilot** is an intelligent AI-powered Git assistant that bridges the gap between natural language and Git commands. It's designed to make Git more accessible and efficient by allowing developers to express their intentions in plain English, while providing context-aware suggestions and safety checks.
3+
**GitPilot** is an intelligent AI-powered Git assistant that revolutionizes how developers interact with Git. Version 2.0 introduces advanced features including visual Git graphs, AI-powered conflict resolution, repository health monitoring, and semantic commit search—all designed to make Git more accessible, efficient, and intelligent.
44

5-
## 🌟 Key Features
5+
## 🚀 What's New in GitPilot 2.0
6+
7+
### 🎯 Visual Git Operations
8+
- **Interactive Git Graph**: Visual representation of commit history with branch relationships
9+
- **Repository Health Monitor**: AI-powered analysis of repository health with actionable insights
10+
- **Advanced Analytics**: Comprehensive repository statistics and performance metrics
11+
12+
### 🤖 Enhanced AI Capabilities
13+
- **AI Conflict Resolution**: Intelligent merge conflict analysis and resolution suggestions
14+
- **Semantic Commit Search**: Natural language search through commit history
15+
- **Repository Health Analysis**: AI-driven recommendations for repository optimization
16+
- **Security Scanning**: Automated detection of sensitive files and potential security issues
17+
18+
### 📊 Advanced Git Tools
19+
- **Multi-format Git Graph**: Tree, table, and JSON output formats for commit visualization
20+
- **Performance Analytics**: Repository size analysis, tracking efficiency metrics
21+
- **Security Analysis**: Comprehensive security scanning with severity-based recommendations
22+
- **Branch Health Monitoring**: Intelligent branch management insights
23+
24+
## 🌟 Core Features
625

726
### 🧠 AI-Powered Command Generation
827
- **Natural Language Processing**: Converts plain English requests into precise Git commands
@@ -211,13 +230,35 @@ gitpilot "show commits from last week"
211230
gitpilot "show what changed in the last commit"
212231
```
213232

214-
## 🔧 Command Line Options
233+
## 🔧 Command Line Interface
234+
235+
GitPilot 2.0 now features a comprehensive command-line interface with specialized commands:
215236

237+
### Main Command
216238
```bash
217-
gitpilot [OPTIONS] [QUERY]
239+
gitpilot [OPTIONS] [QUERY] # Original natural language interface
218240
```
219241

220-
### Options
242+
### New Specialized Commands
243+
```bash
244+
# Repository health analysis
245+
gitpilot health [--detailed] [--model MODEL] [--format json|text]
246+
247+
# Semantic commit search
248+
gitpilot search "search query" [--limit 50] [--model MODEL]
249+
250+
# Visual Git graph
251+
gitpilot graph [--max-commits 20] [--format tree|table|json]
252+
253+
# Conflict resolution assistance
254+
gitpilot conflicts [--model MODEL]
255+
256+
# Repository analysis
257+
gitpilot analyze --security # Security-focused analysis
258+
gitpilot analyze --performance # Performance metrics
259+
```
260+
261+
### Command Options
221262
- `--dry-run, -d`: Show what would be executed without running the command
222263
- `--explain, -e`: Show detailed explanation of the generated command
223264
- `--yes, -y`: Auto-confirm destructive operations
@@ -226,27 +267,22 @@ gitpilot [OPTIONS] [QUERY]
226267
- `--model, -m`: Select AI model (1: Gemini, 2: Llama 3.1 8B, 3: Llama 3.3 70B, 4: DeepSeek R1)
227268
- `--skip-model-selection`: Skip interactive model selection and use default
228269

229-
### Examples with Options
270+
### Examples
230271
```bash
231-
# Preview command without execution
232-
gitpilot "reset to last commit" --dry-run
233-
234-
# Get explanation of the command
235-
gitpilot "merge feature branch" --explain
236-
237-
# Auto-confirm destructive operation
238-
gitpilot "force push to remote" --yes
239-
240-
# View command history
241-
gitpilot --history
242-
243-
# Use specific AI models
244-
gitpilot --model 2 "show me recent commits" # Groq Llama 3.1 8B
245-
gitpilot --model 3 "create a hotfix branch" # Groq Llama 3.3 70B
246-
gitpilot --model 4 "help me resolve merge conflicts" # DeepSeek R1
247-
248-
# Skip model selection for automation
249-
gitpilot --skip-model-selection "add all files"
272+
# Traditional natural language commands
273+
gitpilot "create a new branch for user authentication"
274+
gitpilot "show me recent commits" --model 2
275+
276+
# New specialized features
277+
gitpilot health --detailed --model 1
278+
gitpilot search "authentication fixes" --limit 30
279+
gitpilot graph --format table
280+
gitpilot conflicts --model 3
281+
gitpilot analyze --security
282+
283+
# Advanced usage
284+
gitpilot health --format json > health-report.json
285+
gitpilot graph --max-commits 50 --format json | jq '.commits[] | .message'
250286
```
251287

252288
## ⚙️ Configuration

0 commit comments

Comments
 (0)