Skip to content

Repository files navigation

πŸ’» Smart Commit Messages

Go License CI CodeQL Lint Dependabot

Smart-Commit-Messages - Open source tool by AetherCodeHQ

automation cli commit git golang

What is it?

Smart Commit Messages is a cli tool designed for developers who need fast, reliable, and offline-capable tools. Built with Go for maximum performance and minimal resource usage.

Why should you care?

  • πŸš€ Fast β€” Compiled Go binary, no runtime dependencies
  • πŸ”’ Secure β€” CodeQL security analysis + Dependabot
  • 🌐 Offline-first β€” Works without internet connection
  • πŸ“¦ Lightweight β€” Single binary, minimal footprint
  • πŸ› οΈ Developer-friendly β€” Clean CLI with helpful documentation

Quick Start

Prerequisites

  • Go 1.21 or higher

Install from source

git clone https://github.com/AetherCodeHQ/Smart-Commit-Messages.git
cd Smart-Commit-Messages
go build -o Smart-Commit-Messages .

Run

./Smart-Commit-Messages --help

Usage

# Basic usage
./Smart-Commit-Messages --path ./target

# With options
./Smart-Commit-Messages --path ./target --format json --output report.json

# Verbose mode
./Smart-Commit-Messages --path ./target --verbose

Features

  • βœ… High-performance Go implementation
  • βœ… Cross-platform support (Windows, Linux, macOS)
  • βœ… JSON export for CI/CD integration
  • βœ… Colored terminal output
  • βœ… Configurable via YAML/JSON
  • βœ… Comprehensive documentation

CLI Flags

Flag Description Default
--path Target directory .
--format Output format (json, text, badge) text
--output Output filename stdout
--verbose Enable verbose output false
--config Config file path -

Examples

Basic scan

./Smart-Commit-Messages --path ./my-project

JSON report

./Smart-Commit-Messages --path ./my-project --format json --output report.json

CI/CD integration

# .github/workflows/scan.yml
- name: Run Smart Commit Messages
  run: ./Smart-Commit-Messages --path . --format json --output report.json

Development

# Clone the repo
git clone https://github.com/AetherCodeHQ/Smart-Commit-Messages.git
cd Smart-Commit-Messages

# Build
go build -o Smart-Commit-Messages .

# Run tests
go test ./...

# Lint
golangci-lint run

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

Security

If you discover a security vulnerability, please report it responsibly. See SECURITY.md for details.

License

This project is licensed under the MIT License β€” see the LICENSE file for details.


Built with ❀️ by AetherCode β€’ AetherCode-Core


What's New in v1.1.0

  • Professional documentation with badges
  • CI/CD pipeline with GitHub Actions
  • Security analysis with CodeQL
  • Dependency management with Dependabot
  • Code quality with GolangCI-Lint
  • Issue and PR templates
  • Contributing guidelines

Categories

Category Description
Developer Tools This project is part of the AetherCode ecosystem

Related Projects

Part of AetherCode Core ecosystem.

About

Smart-Commit-Messages - Open source tool by Qyroxen

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages