# ai commit

**Repository Path**: stackcn/ai-commit

## Basic Information

- **Project Name**: ai commit
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-24
- **Last Updated**: 2026-06-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AI Commit

AI Commit is a VS Code extension backed by a Rust core. It generates editable commit messages from Git changes, supports OpenAI-compatible providers, and can infer commit style from repository history when no custom rules are configured.

## Features

- Generate commit messages from staged changes by default.
- Optionally generate from working tree changes when nothing is staged.
- Configure OpenAI-compatible base URL, model, temperature, max tokens, and streaming.
- Store API keys in VS Code SecretStorage.
- Configure persistent commit rules and commit format.
- Infer language and style from recent commit history when custom rules are empty.
- Stream provider output through the Rust core into the VS Code workflow.
- Apply the final edited message to the VS Code Source Control input without auto-committing.

## Development

```sh
npm install
npm run compile
cargo test -p ai-commit-core
npm run build:core
npm run package:core
```

During local development, either package the Rust binary into `dist/<platform>-<arch>/` or set `aiCommit.core.binaryPath` to the local binary at `target/release/ai-commit-core`.

## Configuration

- `aiCommit.provider.baseUrl`: OpenAI-compatible API base URL.
- `aiCommit.provider.model`: model name.
- `aiCommit.provider.temperature`: sampling temperature.
- `aiCommit.provider.maxTokens`: maximum output tokens.
- `aiCommit.provider.stream`: request streaming output.
- `aiCommit.commit.format`: `conventional` or `freeform`.
- `aiCommit.prompt.customRules`: persistent commit rules with highest priority.
- `aiCommit.history.inferFormat`: infer style from recent commits when custom rules are empty.
- `aiCommit.history.limit`: number of recent commits to inspect.
- `aiCommit.diff.maxBytes`: approximate diff budget.
- `aiCommit.core.binaryPath`: optional path to a Rust core binary.

Use `AI Commit: Set API Key` to save the provider key securely.