Skip to content

README.md

Latest commit

 

History

History
73 lines (50 loc) · 2.84 KB

README.md

File metadata and controls

73 lines (50 loc) · 2.84 KB

Smart Commit AI Documentation

Welcome to the Smart Commit AI documentation! Here you'll find all the information you need to work with the tool.

📚 Table of Contents

🚀 Getting Started

🚀 Deployment

⚙️ Configuration

📊 Examples

🎯 Quick Start

  1. Install: npm install -g smart-commit-ai
  2. Setup: smart-commit setup
  3. Project Configuration: smart-commit generate-config
  4. Create Commit: smart-commit
  5. Smart Deploy: smart-commit deploy-smart

🔧 Key Features

  • 🤖 AI-powered commits - Automatic generation of meaningful commit messages
  • 📋 Conventional Commits - Support for conventional commits standard
  • 🌍 Multi-language - English and Russian languages
  • 🔧 Smart Deploy - Analyze changes and execute only necessary commands
  • ⚡ Fast Deploy - Full deployment of all commands
  • 📦 Local preparation - localCommands (build, rsync) before SSH; fail-fast; per-command remote timeout
  • 🎯 Project Analysis - Automatic project type detection
  • 🔑 Multiple API Keys - Store keys for different providers simultaneously
  • 📁 Project Settings - Override global settings per project

⚠️ Important: Configuration Update (v1.0.13)

Version 1.0.13 introduces major configuration improvements:

  • ⚠️ apiKey is deprecated — use apiKeys object instead
  • ✅ Multiple API keys: Store keys for all providers at once
  • ✅ Project-specific settings: Each project can override global config
  • ✅ New provider: Timeweb AI support added

See Configuration for details.

🆘 Need Help?

If you have questions or issues:

  1. Check Usage Examples
  2. See Troubleshooting
  3. Create an Issue

📝 Contributing to Documentation

We welcome documentation improvements! If you found an error or want to add something useful:

  1. Create an Issue
  2. Submit a Pull Request

Documentation Version: 1.0.14
Last Updated: April 2026
Author: Eugene (prod-broke-again)