goal

Goal Documentation

Welcome to the Goal documentation! Goal is an automated git push tool with enterprise-grade commit intelligence, smart changelog updates, and version tagging.

🚀 What’s New in v2.1

• Enhanced Summary Engine - Business-value focused commit messages
• Capability Detection - Maps code patterns to functional values
• Relation Mapping - config→cli→generator dependency chains
• Quality Metrics - Complexity, coverage, value scores

📚 Documentation Menu

Getting Started

| Guide | Description | |——-|————-| | Installation | How to install Goal | | Quick Start | Get started in 5 minutes | | Basic Usage | Common commands and workflows |

Configuration

| Guide | Description | |——-|————-| | User Configuration | 🆕 Auto-detect git user & license preferences | | Configuration Guide | Complete goal.yaml reference | | Project Strategies | Configure for Python, Node.js, Rust | | Registry Setup | Configure PyPI, npm, crates.io |

Enterprise Features

| Guide | Description | |——-|————-| | Enhanced Summary | 🆕 Business-value commit messages | | Markdown Output | Structured output for LLMs/automation | | Hooks | Pre/post commit and push hooks | | CI/CD Integration | GitHub Actions, GitLab CI |

Examples & Reference

| Guide | Description | |——-|————-| | Examples | Real-world usage patterns | | Command Reference | All commands and options | | Troubleshooting | Common issues and solutions | | FAQ | Frequently asked questions |

📂 Code & Examples

Source Code

| File | Purpose | |——|———| | goal/deep_analyzer.py | AST-based code analysis | | goal/enhanced_summary.py | Business value extraction | | goal/commit_generator.py | Commit message orchestration | | goal/config.py | Configuration & quality thresholds |

Example Projects

| Example | Description | |———|————-| | examples/python-package/ | Python package workflow | | examples/nodejs-app/ | Node.js application | | examples/rust-crate/ | Rust crate publishing | | examples/github-actions/ | CI/CD automation | | examples/git-hooks/ | Pre-commit validation |

🔗 Quick Links

• GitHub Repository
• PyPI Package
• Issue Tracker
• Changelog

🏆 Comparison with Alternatives

Feature	Goal	Conventional Changelog	CodeClimate	Semantic Release
Business Value Titles	✅	❌	❌	❌
Capability Detection	✅	❌	⚠️	❌
Relation Mapping	✅	❌	✅	❌
Quality Metrics	✅	❌	✅	❌
Zero Config	✅	⚠️	❌	⚠️
Multi-language	✅	⚠️	✅	⚠️

See Enhanced Summary for detailed comparison.

🔗 Quick Links

• GitHub Repository
• PyPI Package
• Issue Tracker

📖 Table of Contents

# Goal Documentation
## Getting Started
### Installation
### Quick Start
### Basic Usage
## Configuration
### Configuration Guide
### Project Strategies
### Registry Setup
## Advanced Features
### Examples
### Hooks
### CI/CD Integration
### Markdown Output
## Reference
### Command Reference
### Troubleshooting
### FAQ

This site is open source. Improve this page.