chore(release): 发布 0.9.0 版本并更新路线图
This commit is contained in:
29
README.md
29
README.md
@@ -15,6 +15,7 @@ A powerful AI-powered Git assistant for generating conventional commits, tags, a
|
||||
|
||||
## Features
|
||||
|
||||
- **Repository Initialization**: Bootstrap a local Git repository with `quicommit ginit` — create `.git`, write a minimal `README.md`, generate a `.gitignore` from detected ecosystems, set the initial branch, and add remotes. Runs fully offline and never creates the first commit
|
||||
- **AI-Powered Generation**: Generate commits, tags, and changelogs using LLM APIs (Ollama, OpenAI, Anthropic, Kimi, DeepSeek, OpenRouter) or local models
|
||||
- **Conventional Commits**: Full support for Conventional Commits and commitlint formats
|
||||
- **Profile Management**: Manage multiple Git identities with SSH keys and GPG signing support
|
||||
@@ -48,6 +49,28 @@ Requirements: Rust 1.70+, Git 2.0+
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Initialize a Git Repository
|
||||
|
||||
```bash
|
||||
# Bootstrap the current directory as a Git repository
|
||||
quicommit ginit
|
||||
|
||||
# Specify the initial branch (default: init.defaultBranch, then main)
|
||||
quicommit ginit -b dev
|
||||
|
||||
# Add remotes, repeatable: --add <URL> or --add <NAME>=<URL>
|
||||
quicommit ginit --add https://github.com/user/repo.git
|
||||
quicommit ginit --add upstream=git@github.com:user/repo.git
|
||||
|
||||
# Apply an existing Git profile to the new repository
|
||||
quicommit ginit --profile work
|
||||
|
||||
# Preview only, write nothing
|
||||
quicommit ginit --dry-run
|
||||
```
|
||||
|
||||
`ginit` runs fully offline and is safe to re-run: it never creates the first commit and never overwrites an existing `README.md` or `.gitignore`.
|
||||
|
||||
### Initialize
|
||||
|
||||
```bash
|
||||
@@ -390,6 +413,8 @@ quicommit config reset --force
|
||||
|
||||
## Configuration File
|
||||
|
||||
> For a complete categorized reference — quick setup, every field, provider defaults, recipes, and troubleshooting — see [docs/configuration-guide.en.md](docs/configuration-guide.en.md).
|
||||
|
||||
Location:
|
||||
- Linux: `~/.config/quicommit/config.toml`
|
||||
- macOS: `~/Library/Application Support/quicommit/config.toml`
|
||||
@@ -564,6 +589,7 @@ src/
|
||||
│ ├── changelog.rs
|
||||
│ ├── profile.rs
|
||||
│ ├── config.rs
|
||||
│ ├── ginit.rs
|
||||
│ └── init.rs
|
||||
├── config/ # Configuration management
|
||||
│ ├── manager.rs
|
||||
@@ -572,7 +598,8 @@ src/
|
||||
├── git/ # Git operations
|
||||
│ ├── commit.rs
|
||||
│ ├── tag.rs
|
||||
│ └── changelog.rs
|
||||
│ ├── changelog.rs
|
||||
│ └── init.rs
|
||||
├── llm/ # LLM integration (rig-core based)
|
||||
│ ├── mod.rs
|
||||
│ ├── prompts.rs
|
||||
|
||||
Reference in New Issue
Block a user