Files

[change] README.md

2025-06-02 00:21:33 +02:00

4.7 KiB

Raw Blame History

Auto-Git

Author: Victor Giers

⚠️ This README.md has been automatically generated using AI and might contain hallucinations or inaccuracies. Please proceed with caution!

Auto-Git is a unique and interactive desktop application designed to help you manage your Git repositories with ease. It features a playful cat mascot that guides you through various Git operations, making the process more engaging and user-friendly.

Features

Interactive Cat Mascot: A cute cat character that provides feedback and assistance during Git operations.
Intelligent Committing: Set thresholds for automatic committing based on file changes or time intervals.
README Generation: Automatically generate README.md files for your repositories using AI models.
Folder Management: Easily add, remove, and select Git folders to monitor.
Commit History: View commit history with detailed diffs and options to revert or checkout commits.
Push to Gitea: Push your commits directly to a Gitea server with ease.
Customizable Settings: Adjust various settings such as sky mode, autostart, and commit thresholds.

Prerequisites

Before installing Auto-Git, ensure that both Git and Ollama are installed and available in your system’s PATH:

Git
- Download and install from https://git-scm.com/downloads
- Verify with:
```
git --version
```
Ollama
- Download and install from https://ollama.com
- Verify with:
```
ollama --version
```

Installation

Download the latest release for your platform:

macOS (arm64)
Auto-Git 1.0.0 (macOS arm64).dmg
Windows (x64)
Auto-Git 1.0.0 (Setup Windows x64).exe
Windows (ARM64)
Auto-Git 1.0.0 (Setup Windows ARM64).exe

(Linux builds coming soon.)

Download the appropriate installer for your system.
Run the installer and follow the on-screen instructions.
Launch Auto-Git from your applications menu (macOS) or Start menu (Windows).

Usage

Add a Folder
- Click on “Add Folder” to select and add a Git repository to Auto-Git.
Monitor Folders
- Select a folder in the sidebar to monitor its changes and view commit history.
Commit Changes
- Auto-Git will automatically commit changes when thresholds are reached, or you can manually commit with a custom message.
Generate README
- Use the built-in AI integration to generate or update a README.md for any monitored repository.
Push to Gitea
- Configure your Gitea API key in Settings, then push commits directly from Auto-Git.

Settings

Sky Mode:
Toggle between light and dynamic themes that adjust color to the current sky color in your area.
Autostart:
Enable or disable Auto-Git to start automatically on system boot.
Close to Tray:
Minimize Auto-Git to the system tray instead of closing it completely.
Intelligent Commit Thresholds:
Set file change or time-based thresholds for automatic commits.
AI Model Selection:
- Default for commit message inference: qwen2.5-coder:7b
- Default for README generation: qwen2.5-coder:32b
Gitea API Key:
Enter your Gitea API token to push repositories online with one click.

Build from Source

If you want to build Auto-Git yourself, follow these steps:

Clone or download the repository to your local machine.
Install Node.js (version 16+ recommended) and npm.
Open a terminal, navigate into the project folder, and run:
```
npm install
```

Optional: If you need to adjust architectures or targets, modify package.json under the "build" section.

Example for Windows x64 only:

"build": {
  "win": {
    "icon": "win/icon.ico",
    "target": [
      {
        "target": "nsis",
        "arch": ["x64"]
      }
    ]
  }
}

Build the distributables:
```
npm run dist
```
- On an ARM64 machine, to produce an x64 Windows installer, first ensure "arch": ["x64"] is under "win.target", then:
```
npm run dist
```
The output installers/packages will be located in the dist/ directory.

License

This project is licensed under the MIT License. See LICENSE for details.

4.7 KiB Raw Blame History Unescape Escape