feat: 新增系统密钥环安全存储API密钥与自动生成变更日志功能
This commit is contained in:
40
README.md
40
README.md
@@ -6,6 +6,8 @@ A powerful AI-powered Git assistant for generating conventional commits, tags, a
|
||||
|
||||
[Still in early development, some features may not be complete. Feedback and contributions are welcome.]
|
||||
|
||||
> ⚠️ **Important Notice**: QuiCommit now uses system keyring to store API keys securely. This change may cause breaking changes to your existing configuration. If you encounter issues after updating, please run `quicommit config reset --force` to reset your configuration, then reconfigure your settings.
|
||||
|
||||

|
||||

|
||||
|
||||
@@ -159,30 +161,30 @@ quicommit profile token
|
||||
```bash
|
||||
# Configure Ollama (local)
|
||||
quicommit config set-llm ollama
|
||||
quicommit config set-ollama --url http://localhost:11434 --model llama2
|
||||
quicommit config set-llm ollama --url http://localhost:11434 --model llama2
|
||||
|
||||
# Configure OpenAI
|
||||
quicommit config set-llm openai
|
||||
quicommit config set-openai-key YOUR_API_KEY
|
||||
quicommit config set-api-key YOUR_API_KEY
|
||||
|
||||
# Configure Anthropic Claude
|
||||
quicommit config set-llm anthropic
|
||||
quicommit config set-anthropic-key YOUR_API_KEY
|
||||
quicommit config set-api-key YOUR_API_KEY
|
||||
|
||||
# Configure Kimi (Moonshot AI)
|
||||
quicommit config set-llm kimi
|
||||
quicommit config set-kimi-key YOUR_API_KEY
|
||||
quicommit config set-kimi --base-url https://api.moonshot.cn/v1 --model moonshot-v1-8k
|
||||
quicommit config set-api-key YOUR_API_KEY
|
||||
quicommit config set-llm kimi --base-url https://api.moonshot.cn/v1 --model moonshot-v1-8k
|
||||
|
||||
# Configure DeepSeek
|
||||
quicommit config set-llm deepseek
|
||||
quicommit config set-deepseek-key YOUR_API_KEY
|
||||
quicommit config set-deepseek --base-url https://api.deepseek.com/v1 --model deepseek-chat
|
||||
quicommit config set-api-key YOUR_API_KEY
|
||||
quicommit config set-llm deepseek --base-url https://api.deepseek.com/v1 --model deepseek-chat
|
||||
|
||||
# Configure OpenRouter
|
||||
quicommit config set-llm openrouter
|
||||
quicommit config set-openrouter-key YOUR_API_KEY
|
||||
quicommit config set-openrouter --base-url https://openrouter.ai/api/v1 --model openai/gpt-4
|
||||
quicommit config set-api-key YOUR_API_KEY
|
||||
quicommit config set-llm openrouter --base-url https://openrouter.ai/api/v1 --model openai/gpt-4
|
||||
|
||||
# Set commit format
|
||||
quicommit config set-commit-format conventional
|
||||
@@ -205,8 +207,14 @@ quicommit config set-keep-changelog-types-english true
|
||||
# Test LLM connection
|
||||
quicommit config test-llm
|
||||
|
||||
# Check keyring availability
|
||||
quicommit config check-keyring
|
||||
|
||||
# Show config file path
|
||||
quicommit config path
|
||||
|
||||
# Reset configuration to defaults
|
||||
quicommit config reset
|
||||
quicommit config reset --force
|
||||
```
|
||||
|
||||
## Command Reference
|
||||
@@ -396,12 +404,24 @@ quicommit config set llm.provider ollama
|
||||
# Get configuration value
|
||||
quicommit config get llm.provider
|
||||
|
||||
# Set API key (stored in system keyring)
|
||||
quicommit config set-api-key YOUR_API_KEY
|
||||
|
||||
# Delete API key from keyring
|
||||
quicommit config delete-api-key
|
||||
|
||||
# Test LLM connection
|
||||
quicommit config test-llm
|
||||
|
||||
# List available models
|
||||
quicommit config list-models
|
||||
|
||||
# Check keyring availability
|
||||
quicommit config check-keyring
|
||||
|
||||
# Show config file path
|
||||
quicommit config path
|
||||
|
||||
# Export configuration
|
||||
quicommit config export -o config-backup.toml
|
||||
|
||||
|
||||
Reference in New Issue
Block a user