@mehmetsagir/git-ai 0.0.9 → 0.0.19

package/README.md

@@ -1,396 +1,234 @@
-# Git AI
+# git-ai
 
-AI-powered git commit tool. Analyzes git diffs, groups them logically, and creates commit messages in Conventional Commits standard.
+AI-powered git commit tool that analyzes your changes, groups them logically, and creates meaningful commits following the Conventional Commits standard.
 
 ## Features
 
-- 🤖 **AI-Powered Analysis**: Analyzes git diffs with OpenAI
-- 📦 **Smart Grouping**: Groups changes logically
-- 📝 **Conventional Commits**: Uses standard commit message format
-- 👤 **Multiple Git User Support**: Manages multiple git user profiles
-- 🔒 **Secure**: Commits are not pushed automatically, provides manual control
+- **Smart Commit Grouping** - AI analyzes your changes and groups related files together by feature or purpose
+- **Conventional Commits** - Automatically generates commit messages in standard format (`feat`, `fix`, `refactor`, `chore`, etc.)
+- **Stash Viewer** - Browse and manage git stashes in a beautiful web UI with diff viewer
+- **Safe Workflow** - Always shows a commit plan for your approval before making any changes
 
 ## Installation
 
-### Global Installation
-
 ```bash
 npm install -g @mehmetsagir/git-ai
 ```
 
-After installation, you can use `git-ai` command directly:
-
-```bash
-git-ai setup
-git-ai commit
-```
+## Setup
 
-### Using with npx (no installation required)
+Before using git-ai, you need to configure your OpenAI API key:
 
 ```bash
-npx @mehmetsagir/git-ai setup
-npx @mehmetsagir/git-ai commit
-```
-
-## Initial Setup
-
-Run the setup command on first use:
-
-```bash
-# If installed globally
 git-ai setup
-
-# Or with npx
-npx @mehmetsagir/git-ai setup
 ```
 
-This command:
+You'll be prompted to enter your OpenAI API key. Get one from [OpenAI Platform](https://platform.openai.com/api-keys).
 
-- Asks for your OpenAI API key
-- Detects your git user profiles
-- Allows you to select a default git user
-- Saves configuration to `~/.git-ai/config.json`
-
-## Usage
+## Commands
 
-### Creating Commits
+### `git-ai commit`
 
-**With default user:**
+Analyze all changes in your repository and create intelligent commits.
 
 ```bash
-# If installed globally
 git-ai commit
-
-# Or with npx
-npx @mehmetsagir/git-ai commit
 ```
 
-**With a different user:**
-
-```bash
-# Using shortcut (easiest method - single or multi-character)
-git-ai commit --user my
-git-ai commit --user g
-git-ai commit --user work
-git-ai commit -u personal
-
-# Using email
-git-ai commit --user user@example.com
-
-# Using user ID (ID shown during setup)
-git-ai commit --user global-user@example.com
-```
-
-This command:
-
-1. Analyzes git diffs (staged + unstaged)
-2. Groups changes with OpenAI
-3. Creates Conventional Commits format messages for each group
-4. Shows commit plan and asks for confirmation
-5. Creates each group as a separate commit after approval
-6. **Does not push** - you need to push manually
-
-### Example Output
+**What it does:**
+1. Scans all changes (staged, unstaged, and untracked files)
+2. Sends diff to AI for analysis
+3. Groups related files together
+4. Generates commit messages for each group
+5. Shows you the commit plan for approval
+6. Creates commits after your confirmation
 
+**Example output:**
 ```
-🤖 Git Commit AI
+🤖 Git AI
 
-✓ Changes analyzed
+✓ Found 5 file(s), 8 change(s)
 
-✓ Analysis complete: 3 groups created
+Changes:
+  + src/new-feature.ts
+  ~ src/auth.ts
+  ~ src/config.ts
+  - src/old-file.ts
 
-✓ 3 groups created
+✓ Created 3 commit group(s)
 
 📋 Commit Plan:
 
-Group 1: Authentication feature
-Files: auth.ts, auth.test.ts
-Commit: feat(auth): add OAuth2 authentication support
-  Added OAuth2 authentication support. Implemented token refresh mechanism.
-
-Group 2: UI component updates
-Files: Button.tsx, Input.tsx, styles.css
-Commit: style(ui): update design system colors
-  Updated design system colors. Improved dark mode support.
-
-Group 3: API endpoint refactoring
-Files: api/users.ts, api/types.ts
-Commit: refactor(api): simplify user endpoint logic
-  Simplified user endpoint logic. Improved error handling.
-
-Do you approve this commit plan? (Y/n)
-```
-
-## Conventional Commits Format
-
-The tool uses the [Conventional Commits](https://www.conventionalcommits.org/) standard:
-
-```
-<type>(<scope>): <subject>
-
-<body>
-
-<footer>
-```
-
-### Commit Types
-
-- `feat`: New feature
-- `fix`: Bug fix
-- `refactor`: Code refactoring
-- `style`: Formatting, styling changes
-- `docs`: Documentation
-- `test`: Tests
-- `chore`: Maintenance tasks
-
-## Git User Management
-
-The tool allows you to manage multiple git user profiles:
-
-- Automatic detection from global and local git configs
-- List active git users
-- Default user selection (during setup)
-- Manual profile addition
-- Different user selection during commit with `--user` or `-u` flag
-
-### User Management During Setup
-
-When running the setup command:
-
-1. **Active git user profiles are listed:**
-
-   ```
-   📋 Active Git User Profiles:
-     1. John Doe <john@example.com> (Global) [shortcut: g]
-     2. Jane Smith <jane@example.com> (Local) [shortcut: t]
-   ```
+1. Add authentication feature
+   src/auth.ts
+   src/new-feature.ts
+   → feat(auth): add login functionality
 
-2. **Shortcuts can be added for each user:**
+2. Update configuration
+   src/config.ts
+   → refactor(config): simplify config handling
 
-   - "Would you like to add a shortcut?" question is asked for each user
-   - Shortcut key is entered (can be single or multi-character, e.g., `g`, `my`, `work`, `personal`)
-   - Shortcuts can be used during commit
+3. Remove deprecated code
+   src/old-file.ts
+   → chore: remove unused files
 
-3. **Default user is selected:**
+? Proceed with commits? Yes
 
-   - Automatically selected if there's only one user
-   - Selection is made if there are multiple users
+✓ 3 commit(s) created
 
-4. **Optionally, more profiles can be added**
-
-5. **Default user can be updated after adding new profiles**
-
-### User Selection During Commit
-
-**Default usage:**
-
-```bash
-git-ai commit
-# Uses default user from config
+⚠ Don't forget to push: git push
 ```
 
-**With different user:**
-
-```bash
-# Using shortcut (easiest - recommended, single or multi-character)
-git-ai commit --user my
-git-ai commit --user work
-git-ai commit -u personal
+### `git-ai stash`
 
-# Using email address
-git-ai commit --user jane@example.com
-
-# Short form
-git-ai commit -u jane@example.com
-
-# Using user ID (ID shown during setup)
-git-ai commit --user local-jane@example.com
-```
-
-**To view current users:**
+Open a web-based UI to browse and manage your git stashes.
 
 ```bash
-git-ai list
-# or
-git-ai users
+git-ai stash
 ```
 
-## Commands
+**Features:**
+- View all stashes in a clean list
+- Click to see changed files and full diff
+- VS Code-style split diff view (Original | Modified)
+- Apply stash to your working directory
+- Delete stashes you no longer need
+- Syntax highlighting for code changes
 
-All commands can be used with `git-ai` (if installed globally) or `npx @mehmetsagir/git-ai`:
+### `git-ai setup`
 
-### Setup
+Configure or update your OpenAI API key.
 
 ```bash
 git-ai setup
-# or
-npx @mehmetsagir/git-ai setup
 ```
 
-Initial setup - OpenAI API key and git user configuration.
+### `git-ai reset`
 
-### Commit
+Reset all configuration (removes stored API key).
 
 ```bash
-git-ai commit [--user <user>]
-# or
-npx @mehmetsagir/git-ai commit [--user <user>]
+git-ai reset
 ```
 
-Analyze git diffs and create commits. Use `--user` or `-u` to specify a different git user.
+## Configuration
 
-### Add User
+Configuration is stored in `~/.git-ai/config.json`:
 
-```bash
-git-ai add
-# or
-git-ai add-user
+```json
+{
+  "openaiKey": "sk-..."
+}
 ```
 
-Add a new git user profile.
+## Requirements
 
-### List Users
+- Node.js >= 14.0.0
+- Git repository
+- OpenAI API key
 
-```bash
-git-ai list
-# or
-git-ai users
-```
+## Contributing
 
-List all configured git user profiles.
+Contributions are welcome! Here's how you can help:
 
-### Remove User
+### Development Setup
 
-```bash
-git-ai remove
-# or
-git-ai delete
-```
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/mehmetsagir/git-ai.git
+   cd git-ai
+   ```
 
-Remove a git user profile interactively.
+2. **Install dependencies**
+   ```bash
+   npm install
+   ```
 
-### Reset
+3. **Build the project**
+   ```bash
+   npm run build
+   ```
 
-```bash
-git-ai reset
-```
+4. **Test locally**
+   ```bash
+   # Run directly
+   node bin/git-ai [command]
 
-Reset all configuration (deletes OpenAI key and all git users).
+   # Or link globally
+   npm link
+   git-ai [command]
+   ```
 
-### Update
+### Project Structure
 
-```bash
-git-ai --update
+```
+src/
+├── index.ts          # CLI entry point and command routing
+├── git.ts            # Git operations (using simple-git)
+├── openai.ts         # OpenAI API integration
+├── commit.ts         # Commit workflow logic
+├── stash.ts          # Stash viewer web UI
+├── config.ts         # Configuration management
+├── setup.ts          # Setup wizard
+├── reset.ts          # Reset configuration
+├── prompts.ts        # AI prompts for commit analysis
+├── types.ts          # TypeScript type definitions
+└── utils/
+    ├── errors.ts     # Error handling utilities
+    └── hunk-parser.ts # Diff parsing utilities
 ```
 
-Check for updates and update to the latest version. The tool also automatically checks for updates in the background and will notify you if a new version is available.
-
-## Example Scenario
-
-1. **Run setup:**
+### Making Changes
 
+1. Create a new branch for your feature
    ```bash
-   # If installed globally
-   git-ai setup
-
-   # Or with npx
-   npx @mehmetsagir/git-ai setup
+   git checkout -b feature/your-feature-name
    ```
 
-   - 3 user profiles detected
-   - Shortcuts added for each user:
-     - `work@company.com` → shortcut: `w`
-     - `personal@gmail.com` → shortcut: `p`
-     - `other@example.com` → shortcut: `o`
-   - `work@company.com` selected as default
-
-2. **For work commit (default user):**
+2. Make your changes and test them locally
 
+3. Build and verify there are no TypeScript errors
    ```bash
-   git-ai commit
-   # Uses work@company.com
+   npm run build
    ```
 
-3. **For personal project (using shortcut):**
-
+4. Commit your changes using conventional commits format
    ```bash
-   git-ai commit --user p
-   # or
-   git-ai commit -u p
-   # Uses personal@gmail.com
+   git commit -m "feat: add new feature"
    ```
 
-4. **For other project (using shortcut):**
+5. Push and create a pull request
    ```bash
-   git-ai commit --user o
-   # Uses other@example.com
+   git push origin feature/your-feature-name
    ```
 
-## Configuration
+### Commit Message Guidelines
 
-Configuration file: `~/.git-ai/config.json`
+We follow [Conventional Commits](https://www.conventionalcommits.org/):
 
-```json
-{
-  "openaiKey": "sk-...",
-  "gitUsers": [
-    {
-      "id": "global-user@example.com",
-      "name": "John Doe",
-      "email": "user@example.com",
-      "scope": "global",
-      "label": "John Doe <user@example.com> (Global)",
-      "shortcut": "g"
-    }
-  ],
-  "defaultGitUser": "global-user@example.com"
-}
-```
+- `feat:` - New features
+- `fix:` - Bug fixes
+- `refactor:` - Code changes that neither fix bugs nor add features
+- `chore:` - Maintenance tasks
+- `docs:` - Documentation changes
+- `style:` - Code style changes (formatting, etc.)
+- `test:` - Adding or updating tests
 
-## Requirements
+### Reporting Issues
 
-- Node.js >= 14.0.0
-- OpenAI API key
-- Git repository
-
-## Security
-
-- Your OpenAI API key is stored locally in `~/.git-ai/config.json`
-- Commits are not automatically pushed
-- Git user information is stored locally
+Found a bug or have a suggestion? [Open an issue](https://github.com/mehmetsagir/git-ai/issues) with:
 
-## Troubleshooting
-
-### "OpenAI API key not found" error
-
-```bash
-# If installed globally
-git-ai setup
-
-# Or with npx
-npx @mehmetsagir/git-ai setup
-```
-
-### "This directory is not a git repository" error
-
-Make sure you're in a git repository:
-
-```bash
-git init  # If it doesn't exist
-```
-
-### "No changes found to commit" error
-
-Make sure you have changes:
-
-```bash
-git status
-```
+- Clear description of the problem or suggestion
+- Steps to reproduce (for bugs)
+- Expected vs actual behavior
+- Your environment (Node.js version, OS, etc.)
 
 ## License
 
 MIT
 
-## Contributing
+## Links
 
-Contributions are welcome! Please open an issue or submit a pull request.
+- [GitHub Repository](https://github.com/mehmetsagir/git-ai)
+- [npm Package](https://www.npmjs.com/package/@mehmetsagir/git-ai)
+- [Report Issues](https://github.com/mehmetsagir/git-ai/issues)

package/dist/commit.d.ts

@@ -1,5 +1,2 @@
-/**
- * Run commit command
- */
-export declare function runCommit(userFlag?: string | null): Promise<void>;
+export declare function runCommit(): Promise<void>;
 //# sourceMappingURL=commit.d.ts.map

package/dist/commit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commit.d.ts","sourceRoot":"","sources":["../src/commit.ts"],"names":[],"mappings":"AAUA;;GAEG;AACH,wBAAsB,SAAS,CAAC,QAAQ,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CA4U7E"}
+{"version":3,"file":"commit.d.ts","sourceRoot":"","sources":["../src/commit.ts"],"names":[],"mappings":"AAUA,wBAAsB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAmN/C"}