GitClean CLI 🚀

A beautiful CLI tool for creating clean, conventional git commits with spell checking and automatic integration

✨ Features

• 🎯 One Command Workflow: gitclean handles everything - add, commit, and push
• 📝 Interactive Prompts: Beautiful, guided commit message creation
• 🔍 Smart Spell Checking: Catches common typos in commit messages
• 🎨 Conventional Commits: Follows conventional commit standards
• 🌟 Beautiful UI: Clean, colorful interface with emojis and spinners
• 🔧 Git Hook Integration: Optional automatic integration with git hooks
• ⚡ Lightning Fast: Optimized for daily development workflow

🚀 Quick Start

Installation

1# Install globally
2npm install -g gitcleancommit
3
4# Or install locally in your project
5npm install --save-dev gitcleancommit

Basic Usage

1# Run the complete workflow (add → commit → push)
2gitclean
3
4# That's it! 🎉

📋 Commands

Primary Commands

1# Interactive commit workflow (recommended)
2gitclean
3
4# Just create a commit (no push)
5gitclean commit
6
7# Check git status
8gitclean status

Setup Commands

1# Install git hooks for automatic integration
2gitclean setup
3
4# Remove git hooks
5gitclean uninstall

🎯 How It Works

When you run gitclean, here's what happens:

1. 📁 Stage Changes: Automatically runs git add .
2. 💬 Interactive Prompt: Guides you through creating a conventional commit message
3. 🔍 Spell Check: Checks for common typos in your commit message
4. 📝 Preview: Shows you exactly what your commit will look like
5. ✅ Commit: Creates the commit with your message
6. 🚀 Push: Automatically pushes to your current branch

🎨 Commit Types

GitClean supports these conventional commit types:

Type	Description	Example
ADD	Add new code or files	ADD: user authentication system
FIX	A bug fix	FIX: resolve login validation issue
UPDATE	Updated existing code	UPDATE: improve database connection logic
DOCS	Documentation changes	DOCS: add API usage examples
TEST	Adding tests	TEST: add unit tests for auth module
REMOVE	Removing code or files	REMOVE: deprecated legacy components

🔍 Spell Checking

GitClean includes intelligent spell checking that catches common programming typos:

• functionallity → functionality
• recieve → receive
• occured → occurred
• seperate → separate
• implmentation → implementation
• And many more...

🛠️ Advanced Usage

Git Hook Integration

For automatic integration with your git workflow:

1# Install hooks
2gitclean setup
3
4# Now every time you run `git commit`, GitClean will prompt you
5git commit

Custom Scopes

You can add scopes to your commits for better organization:

ADD(auth): user login functionality
FIX(api): resolve timeout issues
UPDATE(ui): improve button styling

Breaking Changes

Mark breaking changes for semantic versioning:

ADD!: new API endpoint structure

BREAKING CHANGE: API endpoints now require authentication

📁 Project Structure

gitcleancommit/
├── src/
│   ├── index.ts           # Main CLI entry point
│   ├── prompt.ts          # Interactive prompts
│   ├── git-integration.ts # Git operations
│   ├── spellcheck.ts      # Spell checking logic
│   └── banner.ts          # CLI banner
├── package.json
├── tsconfig.json
├── setup.js              # Post-install setup
└── README.md

🔧 Configuration

GitClean works out of the box with sensible defaults. No configuration file needed!

🤝 Contributing

We welcome contributions! Here's how to get started:

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Make your changes
4. Run tests: npm test
5. Commit using GitClean: gitclean 😉
6. Push to your fork: git push origin feature/amazing-feature
7. Create a Pull Request

📝 Examples

Basic Commit

1$ gitclean
2
3   _____ _ _    _____ _
4  / ____(_) |  / ____| |
5 | |  __ _| |_| |    | | ___  __ _ _ __
6 | | |_ | | __| |    | |/ _ \/ _` | '_ \
7 | |__| | | |_| |____| |  __/ (_| | | | |
8  \_____|_|\__|\_______|_|    \__,_|_| |_|
9
10  Clean, conventional commits made easy
11
12? Select the type of change you're committing: ADD - Add new code or files
13? What is the scope of this change? (optional): auth
14? Write a short, imperative tense description: user login functionality
15? Provide a longer description of the change (optional):
16? Are there any breaking changes? No
17? Add issue references (e.g., "fixes #123", "closes #456"): fixes #42
18
19📝 Generated Commit Message:
20
21┌─────────────────────────────────────────────────────────────────────────────┐
22│ ➕ ADD(auth): user login functionality                                       │
23│ fixes #42                                                                   │
24└─────────────────────────────────────────────────────────────────────────────┘
25
26? Ready to add, commit, and push? (This will run: git add . → git commit → git push) Yes
27
28🚀 Starting GitClean workflow...
29
30✔ Files added: .
31✔ Commit created successfully!
32✔ Pushed to main successfully!
33
34✅ GitClean workflow completed successfully!
35📦 Changes pushed to main

🐛 Troubleshooting

Common Issues

"Not in a git repository"

1# Make sure you're in a git repository
2git init

"No changes to commit"

1# Check what files have changed
2gitclean status
3
4# Or use git status
5git status

"Push failed"

1# Make sure you have a remote repository set up
2git remote add origin <your-repo-url>
3
4# Or check existing remotes
5git remote -v

📄 License

MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Inspired by conventional commits specification
• Built with ❤️ for developers who love clean git history
• Thanks to all contributors who make this tool better

📞 Support

• 🐛 Report bugs
• 💡 Request features
• 📖 Documentation

---

Made with ❤️ by Abhishek

Happy committing! 🚀