qkpr 0.0.11

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 KazooTTT <work@kazoottt.top>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,278 @@
+# qkpr
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+
+Create a Pull Request with interactive branch selection
+## Usage Demo
+
+quick create pr with interactive branch selection
+
+![](docs/images/demo.gif)
+
+## Installation
+
+```bash
+# Using npm
+npm install -g qkpr
+
+# Using pnpm
+pnpm add -g qkpr
+
+# Using yarn
+yarn global add qkpr
+```
+
+## Usage
+
+### Interactive Menu
+
+Navigate to your git repository and run:
+
+```bash
+qkpr
+```
+
+The CLI will show an interactive menu where you can choose from all available features:
+
+- 🔧 Create Pull Request
+- 🤖 Generate Commit Message
+- 🌿 Generate Branch Name
+- ⚙️  Configure API Key
+- 🔧 Configure Model
+
+### Create Pull Request
+
+You can directly access the PR creation feature:
+
+```bash
+qkpr pr
+```
+
+The CLI will interactively guide you through creating a pull request:
+
+1. **Repository Detection**: Automatically detects the current Git repository
+2. **Branch Selection**: Interactively select the target branch with search functionality
+3. **PR Generation**: Generates a standardized PR description with commit summaries
+4. **Clipboard Integration**: Copies the PR description to your clipboard
+5. **Browser Launch**: Opens the PR page in your default browser
+6. **Merge Branch**: Optionally creates a suggested merge branch for conflict resolution
+
+### AI-Powered Commit Message Generation
+
+Generate commit messages automatically using AI:
+
+```bash
+qkpr commit
+```
+
+Features:
+
+- 🤖 **AI-Powered**: Uses Google Gemini 2.0 Flash to analyze your changes
+- 📝 **Angular Convention**: Follows Angular commit message standards
+- 🌿 **Branch Name Suggestion**: Suggests appropriate branch names based on changes
+- 🎯 **Smart Analysis**: Analyzes staged changes (git diff --cached)
+- ✅ **Interactive**: Choose to commit, copy, or regenerate
+
+#### First Time Setup
+
+1. Get your Gemini API Key from [Google AI Studio](https://aistudio.google.com/apikey)
+2. Configure your API key (choose one method):
+
+   - **Method 1**: Using config command
+
+     ```bash
+     qkpr config
+     ```
+
+   - **Method 2**: Using environment variable
+
+     ```bash
+     export QUICK_PR_GEMINI_API_KEY=your_api_key_here
+     # or use the legacy variable name
+     export GEMINI_API_KEY=your_api_key_here
+     ```
+
+Or the tool will prompt you to enter it on first use.
+
+#### Model Configuration
+
+By default, the tool uses `gemini-2.0-flash`. You can configure a different model:
+
+```bash
+qkpr config:model
+```
+
+The tool will:
+
+1. **Dynamically fetch** all available models from Google's API (if API key is configured)
+2. Display a list of models to choose from
+3. Allow custom model name input
+
+Common Gemini models include (updated 2025.11.17, fetched from Google API):
+
+**Common Gemini Models:**
+
+- `gemini-2.5-pro`
+- `gemini-2.5-flash`
+- `gemini-2.0-flash` (default)
+- `gemini-2.0-flash-exp`
+- `gemini-flash-latest`
+
+You can also set the model via environment variable:
+
+```bash
+export QUICK_PR_GEMINI_MODEL=gemini-2.5-pro
+# or use the legacy variable name
+export GEMINI_MODEL=gemini-2.5-pro
+```
+
+#### Workflow Example
+
+```bash
+# Stage your changes
+git add .
+
+# Generate commit message
+qkpr commit
+
+# The tool will:
+# 1. Analyze your staged changes
+# 2. Generate a commit message following Angular conventions
+# 3. Suggest a branch name
+# 4. Ask if you want to commit, copy to clipboard, or regenerate
+```
+
+## Features
+
+### Pull Request Creation
+
+- 🔧 **Interactive Branch Selection**: Choose target branch with search functionality
+- 📌 **Protected Branches**: Highlights and pins important branches (main, master, etc.)
+- 🗂️ **Smart Categorization**: Groups branches by prefix (feat/, fix/, merge/, etc.)
+- ⏰ **Time Display**: Shows last commit time for each branch
+- 📋 **Auto-Generated PR Description**: Includes commit summaries and formatted content
+- 📋 **Clipboard Integration**: Automatically copies PR description to clipboard
+- 🌐 **Browser Integration**: Opens PR comparison page automatically
+- 🔄 **Merge Branch Suggestion**: Offers to create a merge resolution branch
+- 🏷️ **Multi-Platform Support**: Compatible with GitHub, GitLab, and Gitee
+
+### AI Commit Messages
+
+- 🤖 **Gemini AI**: Powered by Google Gemini 2.0 Flash
+- 📝 **Angular Convention**: Follows industry-standard commit message format
+- 🌿 **Branch Naming**: Suggests semantic branch names
+- 🔍 **Smart Analysis**: Analyzes git diff to understand changes
+- 💾 **Secure Storage**: API key stored locally in `~/.qkpr/config.json`
+
+### Other Features
+
+- 🔄 **Auto Update Check**: Notifies when new version is available
+- ⚙️ **Easy Configuration**: Simple setup for API keys
+- 🎨 **Beautiful UI**: Colorful and intuitive terminal interface
+
+## Available Commands
+
+### Interactive Menu (Default)
+
+```bash
+qkpr
+```
+
+Shows an interactive menu to choose from all available features
+
+### Create PR
+
+```bash
+qkpr pr
+```
+
+Directly create a pull request with interactive branch selection
+
+### Generate Commit Message
+
+```bash
+qkpr commit
+```
+
+Directly generate commit message using AI (requires Gemini API key)
+
+### Generate Branch Name
+
+```bash
+qkpr branch
+```
+
+Directly generate a semantic branch name based on your staged changes using AI (requires Gemini API key)
+
+### Configuration
+
+```bash
+qkpr config
+```
+
+Configure Gemini API key for AI features
+
+```bash
+qkpr config:model
+```
+
+Configure Gemini model for AI commit message generation
+
+### Version
+
+```bash
+qkpr --version
+# or
+qkpr -v
+```
+
+### Help
+
+```bash
+qkpr --help
+# or
+qkpr -h
+```
+
+## Requirements
+
+- `git` version 2.0+
+- Node.js version 18+
+- Gemini API key (for AI commit feature) - Get it from [Google AI Studio](https://aistudio.google.com/apikey)
+
+## License
+
+[MIT](./LICENSE) License © [KazooTTT](https://github.com/kazoottt)
+
+## Contributing
+
+Contributions, issues, and feature requests are welcome!
+
+## Note for Developers
+
+This project uses pnpm workspaces and tsdown for building. For development:
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build the project
+pnpm run build
+
+# Run tests
+pnpm run test
+
+# Lint
+pnpm run lint
+```
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/qkpr?style=flat&colorA=080f12&colorB=1fa669
+[npm-version-href]: https://npmjs.com/package/qkpr
+[npm-downloads-src]: https://img.shields.io/npm/dm/qkpr?style=flat&colorA=080f12&colorB=1fa669
+[npm-downloads-href]: https://npmjs.com/package/qkpr
+[license-src]: https://img.shields.io/github/license/kazoottt/qkpr.svg?style=flat&colorA=080f12&colorB=1fa669
+[license-href]: https://github.com/kazoottt/qkpr/blob/main/LICENSE.md

package/README.zh-CN.md

@@ -0,0 +1,278 @@
+# qkpr
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+
+通过交互式分支选择创建 Pull Request 的 CLI 工具
+## 功能演示
+
+快速创建带有交互式分支选择的 PR
+
+![](docs/images/demo.gif)
+
+## 安装
+
+```bash
+# 使用 npm
+npm install -g qkpr
+
+# 使用 pnpm
+pnpm add -g qkpr
+
+# 使用 yarn
+yarn global add qkpr
+```
+
+## 使用方法
+
+### 交互式菜单
+
+导航到你的 Git 仓库并运行：
+
+```bash
+qkpr
+```
+
+CLI 将显示一个交互式菜单，你可以从中选择所有可用的功能：
+
+- 🔧 创建 Pull Request
+- 🤖 生成提交消息
+- 🌿 生成分支名称
+- ⚙️ 配置 API 密钥
+- 🔧 配置模型
+
+### 创建 Pull Request
+
+你可以直接访问 PR 创建功能：
+
+```bash
+qkpr pr
+```
+
+CLI 将通过交互方式指导你创建 Pull Request：
+
+1. **仓库检测**：自动检测当前 Git 仓库
+2. **分支选择**：通过搜索功能交互式选择目标分支
+3. **PR 生成**：生成包含提交摘要的标准化 PR 描述
+4. **剪贴板集成**：将 PR 描述复制到你的剪贴板
+5. **浏览器启动**：在你的默认浏览器中打开 PR 页面
+6. **合并分支**：可选地创建建议的合并分支用于冲突解决
+
+### AI 驱动的提交消息生成
+
+使用 AI 自动生成提交消息：
+
+```bash
+qkpr commit
+```
+
+功能特性：
+
+- 🤖 **AI 驱动**：使用 Google Gemini 2.0 Flash 分析你的变更
+- 📝 **Angular 约定**：遵循 Angular 提交消息标准
+- 🌿 **分支名称建议**：基于变更建议适当的分支名称
+- 🎯 **智能分析**：分析暂存的变更（`git diff --cached`）
+- ✅ **交互式**：选择提交、复制或重新生成
+
+#### 首次设置
+
+1. 从 [Google AI Studio](https://aistudio.google.com/apikey) 获取你的 Gemini API 密钥
+2. 配置你的 API 密钥（选择一种方法）：
+
+   - **方法 1**：使用配置命令
+
+     ```bash
+     qkpr config
+     ```
+
+   - **方法 2**：使用环境变量
+
+     ```bash
+     export QUICK_PR_GEMINI_API_KEY=your_api_key_here
+     # 或者使用旧版变量名
+     export GEMINI_API_KEY=your_api_key_here
+     ```
+
+或者工具会在首次使用时提示你输入。
+
+#### 模型配置
+
+默认情况下，工具使用 `gemini-2.0-flash`。你可以配置不同的模型：
+
+```bash
+qkpr config:model
+```
+
+工具将：
+
+1. **动态获取** Google API 中所有可用模型（如果已配置 API 密钥）
+2. 显示模型列表供选择
+3. 允许自定义模型名称输入
+
+常见的 Gemini 模型包括（更新于 2025.11.17，从 Google API 获取）：
+
+**常见 Gemini 模型：**
+
+- `gemini-2.5-pro`
+- `gemini-2.5-flash`
+- `gemini-2.0-flash`（默认）
+- `gemini-2.0-flash-exp`
+- `gemini-flash-latest`
+
+你也可以通过环境变量设置模型：
+
+```bash
+export QUICK_PR_GEMINI_MODEL=gemini-2.5-pro
+# 或者使用旧版变量名
+export GEMINI_MODEL=gemini-2.5-pro
+```
+
+#### 工作流示例
+
+```bash
+# 暂存你的变更
+git add .
+
+# 生成提交消息
+qkpr commit
+
+# 工具将：
+# 1. 分析你的暂存变更
+# 2. 生成遵循 Angular 约定的提交消息
+# 3. 建议分支名称
+# 4. 询问你是否要提交、复制到剪贴板或重新生成
+```
+
+## 功能特性
+
+### Pull Request 创建
+
+- 🔧 **交互式分支选择**：通过搜索功能选择目标分支
+- 📌 **受保护分支**：高亮和固定重要分支（main、master 等）
+- 🗂️ **智能分类**：按前缀分组分支（feat/、fix/、merge/ 等）
+- ⏰ **时间显示**：显示每个分支的最后提交时间
+- 📋 **自动生成的 PR 描述**：包含提交摘要和格式化内容
+- 📋 **剪贴板集成**：自动将 PR 描述复制到剪贴板
+- 🌐 **浏览器集成**：自动打开 PR 比较页面
+- 🔄 **合并分支建议**：提供创建合并解决分支的选项
+- 🏷️ **多平台支持**：兼容 GitHub、GitLab 和 Gitee
+
+### AI 提交消息
+
+- 🤖 **Gemini AI**：由 Google Gemini 2.0 Flash 驱动
+- 📝 **Angular 约定**：遵循行业标准的提交消息格式
+- 🌿 **分支命名**：建议语义化分支名称
+- 🔍 **智能分析**：分析 git diff 以了解变更
+- 💾 **安全存储**：API 密钥本地存储在 `~/.qkpr/config.json`
+
+### 其他功能
+
+- 🔄 **自动更新检查**：新版本可用时通知
+- ⚙️ **简单配置**：API 密钥的简单设置
+- 🎨 **美观界面**：彩色直观的终端界面
+
+## 可用命令
+
+### 交互式菜单（默认）
+
+```bash
+qkpr
+```
+
+显示交互式菜单以选择所有可用功能
+
+### 创建 PR
+
+```bash
+qkpr pr
+```
+
+通过交互式分支选择直接创建 Pull Request
+
+### 生成提交消息
+
+```bash
+qkpr commit
+```
+
+使用 AI 直接生成提交消息（需要 Gemini API 密钥）
+
+### 生成分支名称
+
+```bash
+qkpr branch
+```
+
+使用 AI 基于你的暂存变更直接生成语义化分支名称（需要 Gemini API 密钥）
+
+### 配置
+
+```bash
+qkpr config
+```
+
+为 AI 功能配置 Gemini API 密钥
+
+```bash
+qkpr config:model
+```
+
+配置用于 AI 提交消息生成的 Gemini 模型
+
+### 版本
+
+```bash
+qkpr --version
+# 或者
+qkpr -v
+```
+
+### 帮助
+
+```bash
+qkpr --help
+# 或者
+qkpr -h
+```
+
+## 系统要求
+
+- `git` 版本 2.0+
+- Node.js 版本 18+
+- Gemini API 密钥（用于 AI 提交功能）- 从 [Google AI Studio](https://aistudio.google.com/apikey) 获取
+
+## 许可证
+
+[MIT](./LICENSE) 许可证 © [KazooTTT](https://github.com/kazoottt)
+
+## 贡献
+
+欢迎贡献、问题反馈和功能请求！
+
+## 开发者注意事项
+
+此项目使用 pnpm 工作区和 tsdown 进行构建。开发环境：
+
+```bash
+# 安装依赖
+pnpm install
+
+# 构建项目
+pnpm run build
+
+# 运行测试
+pnpm run test
+
+# 代码检查
+pnpm run lint
+```
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/qkpr?style=flat&colorA=080f12&colorB=1fa669
+[npm-version-href]: https://npmjs.com/package/qkpr
+[npm-downloads-src]: https://img.shields.io/npm/dm/qkpr?style=flat&colorA=080f12&colorB=1fa669
+[npm-downloads-href]: https://npmjs.com/package/qkpr
+[license-src]: https://img.shields.io/github/license/kazoottt/qkpr.svg?style=flat&colorA=080f12&colorB=1fa669
+[license-href]: https://github.com/kazoottt/qkpr/blob/main/LICENSE.md

package/dist/index.d.mts

@@ -0,0 +1 @@
+export { };