Skip to content

quickstart.md

Latest commit

 

History

History
61 lines (45 loc) · 1020 Bytes

quickstart.md

File metadata and controls

61 lines (45 loc) · 1020 Bytes

Quick Start

Get up and running with Goal in 5 minutes!

Installation

pip install goal

Or install from source:

git clone https://github.com/wronai/goal.git
cd goal
pip install -e .

Initialize Your Project

cd your-project
goal init

This creates:

  • VERSION - Current version file
  • CHANGELOG.md - Changelog template
  • goal.yaml - Configuration with auto-detected settings

Make Your First Commit

  1. Make some changes to your project
  2. Stage them: git add .
  3. Run Goal:
goal push

Goal will:

  • Analyze your changes
  • Generate a smart commit message
  • Update the version
  • Update the changelog
  • Create a git tag
  • Push to remote

2. Make changes

echo "print('Hello, World!')" > app.py git add app.py

Dry run (preview)

goal push --dry-run


## Next Steps

- Read the [Configuration Guide](configuration.md) to customize Goal
- Check out [Examples](examples.md) for advanced workflows
- See [Command Reference](commands.md) for all options