Documentation
AI-powered commit message generator that creates conventional commit messages based on your git changes.
npm install -g cmarta-commitcmarta-commit --versionVisit Cmarta Commit and create an account.
cmarta-commit setupEnter your API key when prompted. The key will be securely stored in your home directory.
Navigate to your git repository and stage your changes:
git add .
cmarta-commitOr stage and commit in one command:
cmarta-commit -aAfter running the command, you'll see:
🤖 Generating commit message... ✨ Generated commit message: "feat(auth): implement two-factor authentication" ? What would you like to do? ❯ Commit with this message Edit the message Generate a new message Cancel
Access your web dashboard at /dashboard
# Setup API key
cmarta-commit setup
# Generate and commit (interactive)
cmarta-commit
# Auto-stage and generate commit
cmarta-commit -a
cmarta-commit --all
# Auto-commit without confirmation
cmarta-commit -y
cmarta-commit --auto
# Combine options
cmarta-commit -a -y# Show version
cmarta-commit --version
# Show help
cmarta-commit --helpThe CLI stores configuration in:
~/.cmarta-commit-config.json%USERPROFILE%\.cmarta-commit-config.json{
"apiKey": "sk_your_api_key_here"
}Re-run setup to update your API key:
cmarta-commit setupgit init# Stage your changes first
git add .
# Or use the auto-stage flag
cmarta-commit -acmarta-commit setupNeed help? Visit your dashboard or contact support.
Version 1.0.0 | Last Updated: December 2024