AI Commit - PraisonAI Documentation

The commit command generates intelligent git commit messages based on your staged changes using AI, with built-in security scanning to prevent accidental exposure of sensitive data.

Quick Start

# Full auto mode: stage, security check, commit, and push
praisonai commit -a

# Interactive mode
git add .
praisonai commit

Usage

Full Auto Mode (Recommended)

praisonai commit -a

This single command will:

Auto-stage all changes (git add -A)
Security scan for sensitive content (API keys, passwords, secrets)
Generate AI commit message from diff
Commit with the generated message
Push to remote repository

Expected Output:

Auto-staging all changes...
Staged changes:
 src/main.py | 15 +++++++++------
 tests/test_main.py | 8 ++++++++
 2 files changed, 17 insertions(+), 6 deletions(-)

Generating commit message...

Suggested commit message:
feat(main): add user authentication with JWT tokens

✅ Committed successfully!
✅ Pushed to remote!

If sensitive content is detected in auto mode, the commit will be automatically aborted for safety. Use --no-verify to skip security checks (not recommended).

Interactive Mode

praisonai commit

Expected Output:

Staged changes:
 src/main.py | 15 +++++++++------
 tests/test_main.py | 8 ++++++++
 2 files changed, 17 insertions(+), 6 deletions(-)

Generating commit message...

Suggested commit message:
feat(main): add user authentication with JWT tokens

- Implement JWT token generation and validation
- Add login and logout endpoints
- Include unit tests for authentication flow

Options:
  [y] Use this message and commit
  [e] Edit the message
  [n] Cancel

Your choice [y/e/n]: 

Commit and Push (Interactive)

praisonai commit --push

This will generate the commit message, commit the changes, and push to the remote repository after confirmation.

Workflow

Stage Changes: Use git add to stage your changes
Run Command: Execute praisonai commit
Review Message: AI generates a commit message based on the diff
Choose Action:
- y - Accept and commit
- e - Edit the message in your default editor
- n - Cancel

Commit Message Format

The AI follows the Conventional Commits specification:

<type>(<scope>): <short description>

<optional body with more details>

Types

Type	Description
`feat`	A new feature
`fix`	A bug fix
`docs`	Documentation changes
`style`	Code style changes (formatting, etc.)
`refactor`	Code refactoring
`test`	Adding or updating tests
`chore`	Maintenance tasks

Examples

feat(auth): add user authentication with JWT tokens

fix(api): resolve null pointer exception in user lookup

docs(readme): update installation instructions

refactor(database): optimize query performance for large datasets

test(auth): add unit tests for login flow

Options

Option	Description
`-a`, `--auto`	Full auto mode: stage all, security check, commit, and push
`--push`	Automatically push after committing (interactive mode)
`--no-verify`	Skip security check (use with caution)

Security Scanning

The commit command includes built-in security scanning to prevent accidental exposure of sensitive data.

Detected Patterns

API Keys & Tokens

API keys (api_key, apikey)
Secret keys (secret_key, secretkey)
Access tokens (access_token, accesstoken)
Auth tokens (auth_token, authtoken)
Client secrets (client_secret)

Cloud Provider Credentials

AWS Access Key IDs (AKIA...)
AWS Secret Access Keys
GitHub Personal Access Tokens (ghp_...)
GitHub OAuth Tokens (gho_...)
GitLab Personal Access Tokens (glpat-...)
Slack Tokens (xox...)

Passwords & Private Keys

Passwords (password, passwd, pwd)
Database passwords (db_password)
Private keys (PEM, RSA, DSA, EC, OPENSSH, PGP)

Sensitive Files

Environment files: .env, .env.local, .env.production, .env.development
SSH keys: id_rsa, id_dsa, id_ecdsa, id_ed25519
Certificates: .pem, .key, .p12, .pfx, .jks, .keystore
Credentials: credentials, secrets.json, secrets.yaml, .htpasswd, .netrc

Security Warning Example

⚠️  SECURITY WARNING: Sensitive content detected!
  • API Key in diff: api_key = "sk-1234567890abcdefghij...
  • Sensitive File in config/.env: .env

Options:
  [c] Continue anyway (not recommended)
  [a] Abort commit
  [i] Ignore and add to .gitignore

Your choice [c/a/i]: 

Auto Mode Behavior

In auto mode (-a), if sensitive content is detected:

The commit is automatically aborted
No changes are pushed
You must fix the issue or use --no-verify to proceed

# Auto mode aborts on security issues
praisonai commit -a
# Output: Auto mode aborted due to security concerns. Use --no-verify to skip.

# Skip security check (not recommended)
praisonai commit -a --no-verify

Requirements

Git must be installed and available in PATH
You must be in a git repository
For interactive mode: changes must be staged with git add
For auto mode (-a): changes will be auto-staged

Error Handling

No Staged Changes

$ praisonai commit
No staged changes. Use 'git add' to stage files first, or use -a/--auto.

Solution: Stage your changes with git add . or use praisonai commit -a for auto-staging

Not in Git Repository

$ praisonai commit
ERROR: Not in a git repository

Solution: Navigate to a git repository or initialize one with git init

Customization

Using a Different Model

OPENAI_MODEL_NAME=gpt-4o praisonai commit

Custom Editor

Set the EDITOR environment variable to use your preferred editor:

export EDITOR=vim
praisonai commit
# Choose 'e' to edit with vim

Best Practices

Review Before Accepting

Always review the generated message before accepting

Stage Related Changes

Stage related changes together for better commit messages

Small Commits

Make small, focused commits for clearer messages

Edit When Needed

Use the edit option to refine the message

Integration with Git Workflow

# Full auto workflow (recommended)
praisonai commit -a

# Interactive workflow
git add src/feature.py tests/test_feature.py
praisonai commit
git push

# Interactive with auto-push
git add .
praisonai commit --push

Troubleshooting

Issue	Solution
Empty commit message	Ensure changes are staged and diff is not empty
API error	Check your OpenAI API key is set
Editor not opening	Set the `EDITOR` environment variable
Push failed	Check remote repository access and authentication
Security warning in auto mode	Fix sensitive content or use `--no-verify`
Auto mode aborted	Remove sensitive files from staging or add to `.gitignore`

CLI Overview - PraisonAI CLI documentation
Planning - AI planning mode

CLI

​Quick Start

​Usage

​Full Auto Mode (Recommended)

​Interactive Mode

​Commit and Push (Interactive)

​Workflow

​Commit Message Format

​Types

​Examples

​Options

​Security Scanning

​Detected Patterns

​Security Warning Example

​Auto Mode Behavior

​Requirements

​Error Handling

​No Staged Changes

​Not in Git Repository

​Customization

​Using a Different Model

​Custom Editor

​Best Practices

Review Before Accepting

Stage Related Changes

Small Commits

Edit When Needed

​Integration with Git Workflow

​Troubleshooting

​Related

Quick Start

Usage

Full Auto Mode (Recommended)

Interactive Mode

Commit and Push (Interactive)

Workflow

Commit Message Format

Types

Examples

Options

Security Scanning

Detected Patterns

Security Warning Example

Auto Mode Behavior

Requirements

Error Handling

No Staged Changes

Not in Git Repository

Customization

Using a Different Model

Custom Editor

Best Practices

Integration with Git Workflow

Troubleshooting

Related