🚀 Docme-Ag: AI-Powered Commit & Versioning Agent

Version: v1.5.1

Docme-Ag is an AI-powered CLI tool that automates commit message generation, versioning, and documentation updates in your software projects.

---

🎯 Features

• AI-Generated Commit Messages - Uses Google Gemini AI to generate commit messages based on code changes.
• Automatic Versioning - Determines the appropriate semantic version number.
• README Auto-Updater - Updates README.md based on new versions and commits.
• GitHub Integration - Works seamlessly with GitHub repositories.
• No Go Required - Runs as a prebuilt binary without requiring Go installation.

---

📥 Installation & Uninstallation

🔹 Quick Install via Installer Script

Easily install docm with the following command:

curl -fsSL https://raw.githubusercontent.com/Dert-Ops/Docme-Ag/main/installer.sh | bash

🔹 Manual Installation

For manual installation, follow these steps:

LATEST_VERSION=$(curl -s https://api.github.com/repos/Dert-Ops/Docme-Ag/releases/latest | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
wget -O docm "https://github.com/Dert-Ops/Docme-Ag/releases/download/$LATEST_VERSION/docm-linux-amd64"
chmod +x docm
sudo mv docm /usr/local/bin/

🔹 Post-Installation Setup

Ensure your GEMINI API KEY is set:

echo 'export GEMINI_API_KEY="your-api-key-here"' >> ~/.bashrc
source ~/.bashrc

For Mac users (zsh default shell):

echo 'export GEMINI_API_KEY="your-api-key-here"' >> ~/.zshrc
source ~/.zshrc

🔹 Uninstallation

To remove docm from your system, run:

sudo rm -f /usr/local/bin/docm
sed -i '/GEMINI_API_KEY/d' ~/.bashrc ~/.zshrc
source ~/.bashrc || source ~/.zshrc

This will remove the binary and environment variables.

---

🚀 Usage

Run the following commands in your terminal:

🔹 Generate AI-powered commit messages:

docm cm

🔹 Generate a new semantic version:

docm vs

🔹 Update README with the latest changes:

docm update-readme

---

📝 Commit Message Standard (Conventional Commits)

This project follows the Conventional Commits standard for clarity and consistency.

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

• type: feat, fix, chore, docs, style, refactor, test
• scope: Affected module or component
• description: A concise description of the change

Examples:

feat(api): add user authentication
fix(ui): resolve navbar layout issue
docs(readme): update installation instructions

---

🏷️ Versioning Standard (Semantic Versioning)

Docme-Ag follows Semantic Versioning (SemVer):

MAJOR.MINOR.PATCH

• MAJOR - Breaking changes
• MINOR - New features (backward-compatible)
• PATCH - Bug fixes and minor improvements

Examples:

1.0.0  # Initial stable release
1.1.0  # New feature added
1.1.1  # Minor bug fix
2.0.0  # Breaking change

---

📑 Changelog

v1.5.1

• Commit: feat: implement RunReadmeAgent function
• Changes: Implemented RunReadmeAgent function.

v1.5.0

• Commit: New version released: v1.5.0
• Changes:
  • Added a new command to force README updates.
  • Improved the application installer.
  • Enhanced API key management.

v1.4.2

• Commit: New version released: v1.4.2
• Changes:
  • Consolidated README updating logic within UpdateProjectDocs function.
  • Added docm update command to force update README.md.
  • Improved installer for Go-independent execution.
  • Optimized API key handling via docm set-api-key command.

---

🎯 Contributing

Contributions are welcome! Open an issue or create a pull request.

📜 License

This project is licensed under the MIT License.