https://github.com/mingeme/aicommit
AI-powered git commit message generator
https://github.com/mingeme/aicommit
ai cli git
Last synced: 2 months ago
JSON representation
AI-powered git commit message generator
- Host: GitHub
- URL: https://github.com/mingeme/aicommit
- Owner: mingeme
- License: mit
- Created: 2025-03-01T07:53:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-01T09:23:32.000Z (over 1 year ago)
- Last Synced: 2025-03-01T09:25:40.219Z (over 1 year ago)
- Topics: ai, cli, git
- Language: TypeScript
- Homepage:
- Size: 42 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# aicommit
> **ANNOUNCEMENT**: This project is no longer maintained. Please migrate to the new project at [github.com/mingeme/fuckmit](https://github.com/mingeme/fuckmit).
`aicommit` is an AI-powered git commit message generator.
## Installation
### Using Homebrew (macOS and Linux)
```bash
# Install from Homebrew tap
brew install mingeme/tap/aicommit
```
### From Source
```bash
# Clone the repository
git clone https://github.com/mingeme/aicommit.git
cd aicommit
# Install dependencies
pnpm install
# Build the project
pnpm run build
# Link the CLI tool globally
pnpm link
```
## Development
```bash
# Run in development mode
pnpm run dev
# Build the project
pnpm run build
# Run tests
pnpm test
```
## Version Management
The version number is automatically generated based on Git tags:
- If the current commit has a tag, that tag will be used as the version (preserving the 'v' prefix if present)
- If the current commit doesn't have a tag, a version in the format `{tag}-{shortHash}` will be generated, where `{tag}` is the tag and `{shortHash}` is the short Git commit hash
- If no tags exist in the repository, a fallback version in the format `v0.1.0-{shortHash}` will be used
- The version is stored in `src/utils/version.ts`, which is automatically generated and should not be manually edited
- The version file is only generated if it doesn't already exist, to regenerate it run `pnpm run version`
- The `src/utils/version.ts` file is included in `.gitignore` since it's generated during build
## Usage
```bash
# Show help
aicommit --help
# Generate a commit message and create a commit
aicommit
# Generate a commit message without creating a commit (dry-run mode)
aicommit --dry-run
# or
aicommit -d
# Authenticate with a provider
aicommit auth add
# or
aicommit auth use
# or set specific provider properties
aicommit auth set .
# Manage prompt configurations
aicommit prompt init # Create a default prompt configuration in current directory
aicommit prompt init --global # Create a default prompt configuration in global config directory
aicommit prompt show # Show current prompt configuration
```
### Options
- `-d, --dry-run`: Generate a commit message without creating a commit
- `auth add `: Add a new provider configuration
- `auth use `: Set the current provider
- `auth set . `: Update a specific property (model, apiKey, or endpoint) for a provider
- `prompt init`: Create a new prompt configuration file
- `prompt show`: Show current prompt configuration
- `-h, --help`: Display help information
## Customizing Prompts
You can customize the prompts used for generating commit messages by creating a `.aicommit.yml` or `.aicommit.yaml` file either in your current working directory or in the global config directory (`~/.config/aicommit/`).
The file should have the following format:
```yaml
prompt:
system: |
Your custom system prompt here
user: |
Your custom user prompt template here
{{diff}}
# Optional: exclude specific files from the diff
exclude:
- "package-lock.json"
- "**/node_modules/**"
- "dist/**"
```
The `{{diff}}` placeholder will be replaced with the actual git diff content.
### Excluding Files from Diff
You can exclude specific files or patterns from the git diff by adding an `exclude` section to your `.aicommit.yml` file:
```yaml
exclude:
- "package-lock.json" # Exclude a specific file
- "**/node_modules/**" # Exclude all node_modules directories recursively
- "dist/**" # Exclude all files in the dist directory
- "**/*.lock" # Exclude all .lock files in any directory
```
The exclude patterns support Git's pathspec syntax, including recursive glob patterns with `**/`. This is useful for excluding generated files, large dependency files, or any content you don't want to include in your commit message generation.
## License
MIT