Skip to content

Commit 07dc531

Browse files
committed
docs:更新资源
1 parent 84558c6 commit 07dc531

File tree

7 files changed

+79
-30
lines changed

7 files changed

+79
-30
lines changed

.gitignore

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
build
2-
venv
3-
dist
4-
.vscode
5-
__pycache__
6-
poetry.lock
1+
poetry.lock
2+
build/
3+
venv/
4+
dist/
5+
.vscode/
6+
**/__pycache__/

README.md

Lines changed: 39 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,70 @@
11
<p align="center">English | <a href="README_zh.md">中文</a><p>
22

3-
# AI Code Context Helper
4-
53
## 📝 Introduction
64

75
AI Code Context Helper is a lightweight desktop application designed for developers collaborating with AI assistants. It provides a visual representation of project structures and enables quick, selective export of file paths and code content to the clipboard, streamlining code communication with ChatGPT, Claude, and other AI assistants.
86

9-
As a supplementary tool, it doesn't aim to replace existing editors or IDEs but focuses specifically on solving the code context transfer challenge in AI programming collaboration. Compared to integrated AI code editors, it offers advantages in simplicity, low learning curve, independence from specific AI services, and minimal resource usage, integrating seamlessly with various development environments.
7+
<p align="center">
8+
<img src="./_images/app_overview.png" width="60%" alt="Application Overview">
9+
</p>
1010

11-
![Application Overview](./_images/app_overview.png)
11+
As a supplementary tool, it doesn't aim to replace existing editors or IDEs but focuses specifically on solving the code context transfer challenge in AI programming collaboration. Compared to integrated AI code editors, it offers advantages in simplicity, low learning curve, independence from specific AI services, and minimal resource usage, integrating seamlessly with various development environments.
1212

13-
<!-- 👆 Main interface screenshot -->
13+
<p align="center">
14+
<img src="./_images/app.gif" width="60%" alt="gif">
15+
</p>
1416

1517
## ✨ Key Features
1618

1719
### Intelligent File Management
20+
1821
- **Directory Tree Visualization**: Display project file structure in tree view
1922
- **File Type Recognition**: Automatically detect text file encodings and distinguish between text and binary files
20-
- **Advanced Filtering**: Support for regex filtering and directory depth limitation for handling large projects
23+
- **Advanced Filtering**: Support for regex filtering, .gitignore rules, and directory depth limitation for handling large projects
2124

2225
### Flexible Selection and Export
26+
2327
- **Multi-selection Support**: Select individual files, multiple files, or entire directories with subdirectories
28+
- **Mouse Selection Mode**: Drag to select/deselect multiple files at once
2429
- **Batch Export**: Export paths, code, or both for selected content
2530
- **Context Menu**: Multiple copy options for different development scenarios
2631

32+
### Integration and Accessibility
33+
34+
- **System Tray Integration**: Minimize to system tray to keep the tool readily available without cluttering your desktop
35+
- **Global Hotkey**: Press Ctrl+2 anywhere to show/hide the application window
36+
- **Always On Top Option**: Keep the window visible while working with other applications
37+
- **File System Integration**: Open folders in Explorer or launch terminal directly from the context menu
38+
2739
### Customization and Ease of Use
40+
2841
- **Multilingual Support**: Switch between English and Chinese interfaces
2942
- **Output Format Customization**: Configure prefix and suffix formats for code and paths
43+
- **Advanced Settings Toggle**: Show/hide advanced options to maximize space for directory tree
3044
- **Lightweight Implementation**: Low resource consumption, quick startup, seamlessly integrates with existing development workflows
3145

46+
## 🔑 Shortcuts and Special Features
47+
48+
- **Ctrl+C**: Copy path and code of selected files
49+
- **Ctrl+B**: Copy filename of selected files
50+
- **Ctrl+F**: Open selected folder in file explorer
51+
- **Ctrl+T**: Open command line in selected folder
52+
- **Ctrl+2**: Global hotkey to show/hide the application from anywhere
53+
- **Tree State Preservation**: Application remembers the expanded state of each project directory between sessions
54+
3255
## 💡 Usage Tips
3356

3457
### Best Practice: Combining Project Structure with Code Content
3558

3659
For better AI comprehension of your project, follow these steps:
3760

3861
1. **First Share Project Structure**:
62+
3963
- Select the root directory and use the "Copy Tree" function
4064
- Paste the directory tree to the AI to provide overall project architecture
4165

4266
2. **Then Share Key Files**:
67+
4368
- Select relevant files based on your requirements (multiple files or directories)
4469
- Use "Copy Path and Code" to provide all necessary files at once
4570

@@ -61,9 +86,9 @@ When modifying an entire functional module:
6186

6287
### Context Menu
6388

64-
![Right-click Menu](./_images/context_menu.png)
65-
66-
<!-- 👆 Right-click menu screenshot -->
89+
<p align="center">
90+
<img src="./_images/context_menu.png" width="60%" alt="Right-click Menu">
91+
</p>
6792

6893
## 🔧 Installation and Usage
6994

@@ -87,10 +112,13 @@ When modifying an entire functional module:
87112

88113
- **Show Hidden Files**: Toggle display of hidden files and folders
89114
- **Show Files/Show Folders**: Control what appears in the tree view
90-
- **Preserve Tree State**: Maintain expansion/collapse state when resetting
91115
- **Use Relative Path**: Use paths relative to the root directory instead of absolute paths
116+
- **Filter by .gitignore**: Apply rules from project's .gitignore file
117+
- **Mouse Selection Mode**: Enable drag selection for easier batch operations
92118
- **Max Depth**: Limit the display depth of the directory tree
93119
- **File Filter**: Filter displayed files using regular expressions
120+
- **Keep on Top**: Keep the window above all other applications
121+
- **Advanced Options Toggle**: Hide/show advanced settings to maximize tree display space
94122

95123
## 🛠️ Building from Source
96124

@@ -115,4 +143,4 @@ poetry run python -m cx_Freeze build
115143

116144
## 📄 License
117145

118-
This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.
146+
This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.

README_zh.md

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,57 @@
11
<p align="center"><a href="README.md">English</a> | 中文<p>
22

3-
# AI Code Context Helper (AI 代码上下文助手)
4-
53
## 📝 简介
64

75
AI Code Context Helper 是一款轻量级桌面应用,专为开发者与 AI 助手协作设计。它提供可视化的项目结构展示,支持快速选择性导出文件路径和代码内容到剪贴板,使与 ChatGPT、Claude 等 AI 助手的代码交流更加高效。
86

9-
作为一个辅助工具,它不尝试替代现有编辑器或 IDE,而是专注于解决 AI 编程协作中的代码上下文传递问题。与集成式 AI 代码编辑器相比,它具有界面简洁、学习门槛低、不依赖特定 AI 服务、资源占用少等优势,可无缝融入各种开发环境。
7+
<p align="center">
8+
<img src="./_images/app_overview.png" width="60%" alt="应用概览截图">
9+
</p>
1010

11-
![应用概览截图](./_images/app_overview.png)
11+
作为一个辅助工具,它不尝试替代现有编辑器或 IDE,而是专注于解决 AI 编程协作中的代码上下文传递问题。与集成式 AI 代码编辑器相比,它具有界面简洁、学习门槛低、不依赖特定 AI 服务、资源占用少等优势,可无缝融入各种开发环境。
1212

13-
<!-- 👆 主界面截图 -->
13+
<p align="center">
14+
<img src="./_images/app.gif" width="60%" alt="动图">
15+
</p>
1416

1517
## ✨ 主要特性
1618

1719
### 智能文件管理
1820

1921
- **目录树可视化**:树形视图显示项目文件结构
2022
- **文件类型识别**:自动检测文本文件编码,区分文本与二进制文件
21-
- **筛选功能**支持正则表达式过滤与目录深度限制,便于处理大型项目
23+
- **高级筛选**支持正则表达式过滤、.gitignore 规则应用和目录深度限制,便于处理大型项目
2224

2325
### 灵活选择与导出
2426

2527
- **多选支持**:可选择单个文件、多个文件或整个目录及其子目录
28+
- **鼠标框选模式**:通过拖动鼠标一次性选择/取消选择多个文件
2629
- **批量导出**:支持导出选中内容的路径、代码或两者兼有
2730
- **上下文菜单**:提供多种复制选项,适用于不同开发场景
2831

32+
### 集成与便捷性
33+
34+
- **系统托盘集成**:最小化到系统托盘,随时可用但不占用桌面空间
35+
- **全局热键**:在任何应用中按下 Ctrl+2 快捷键即可显示/隐藏应用窗口
36+
- **窗口置顶选项**:使窗口保持在其他应用之上,便于操作
37+
- **文件系统集成**:直接从上下文菜单在资源管理器中打开文件夹或启动命令行终端
38+
2939
### 定制化与易用性
3040

3141
- **多语言支持**:支持中英文切换
3242
- **输出格式定制**:可配置代码和路径的前缀后缀格式
43+
- **高级选项切换**:可隐藏/显示高级设置,最大化目录树显示空间
3344
- **轻量实现**:低资源占用,启动迅速,无缝融入现有开发工作流
3445

46+
## 🔑 快捷键与特殊功能
47+
48+
- **Ctrl+C**:复制选中文件的路径和代码
49+
- **Ctrl+B**:复制选中文件的文件名
50+
- **Ctrl+F**:在资源管理器中打开选中文件夹
51+
- **Ctrl+T**:在选中文件夹中打开命令行终端
52+
- **Ctrl+2**:全局热键,从任何地方显示/隐藏应用程序
53+
- **树状态保持**:应用程序会在会话之间记住每个项目目录的展开状态
54+
3555
## 💡 使用技巧
3656

3757
### 最佳实践:结合目录结构与代码内容
@@ -60,17 +80,15 @@ AI Code Context Helper 是一款轻量级桌面应用,专为开发者与 AI
6080
2. 右键选择"复制路径与代码",自动包含该目录下所有文件
6181
3. 向 AI 描述:"请分析这个认证模块的代码,并提出改进建议"
6282

63-
> 如果代码在 5000 行以内,你可以直接复制所有代码交给 claude 或者 chatgpt等ai,让它帮助审查代码质量,并让ai完整提供修改后的代码即可。本质上是你在与ai进行结对编程,如果你擅长代码和描述需求,那么效率就高,如果都不擅长,那么全是ai判断,容易出现误判。
64-
65-
83+
> 如果代码在 5000 行以内,你可以直接复制所有代码交给 Claude 或者 ChatGPT 等 AI,让它帮助审查代码质量,并让 AI 完整提供修改后的代码即可。本质上是你在与 AI 进行结对编程,如果你擅长代码和描述需求,那么效率就高,如果都不擅长,那么全是 AI 判断,容易出现误判。
6684
6785
## 📸 应用截图
6886

6987
### 目录树菜单
7088

71-
![右键菜单](./_images/context_menu.png)
72-
73-
<!-- 👆 右键菜单操作截图 -->
89+
<p align="center">
90+
<img src="./_images/context_menu.png" width="60%" alt="右键菜单">
91+
</p>
7492

7593
## 🔧 安装与使用
7694

@@ -94,10 +112,13 @@ AI Code Context Helper 是一款轻量级桌面应用,专为开发者与 AI
94112

95113
- **显示隐藏文件**:是否显示隐藏文件和文件夹
96114
- **显示文件/显示文件夹**:控制树视图中的显示内容
97-
- **固定目录树**:重置时保留目录树的展开/收起状态
98115
- **使用相对路径**:复制时使用相对路径而非绝对路径
116+
- **根据.gitignore 过滤**:应用项目.gitignore 文件中的规则
117+
- **鼠标框选模式**:启用拖动选择功能,方便批量操作
99118
- **最大深度**:限制目录树的显示深度
100119
- **文件过滤**:使用正则表达式过滤显示的文件
120+
- **窗口置顶**:使窗口保持在所有其他应用之上
121+
- **高级选项切换**:隐藏/显示高级设置,最大化树显示空间
101122

102123
## 🛠️ 从源码构建
103124

_images/app.gif

271 KB
Loading

_images/app_overview.png

90.3 KB
Loading
-14.3 KB
Binary file not shown.
-246 Bytes
Loading

0 commit comments

Comments
 (0)