first commit
142
docs/en/cache-management.md
Normal file
@@ -0,0 +1,142 @@
|
||||
# UV Cache Management Guide
|
||||
|
||||
## 🔍 Problem Description
|
||||
|
||||
Since this project uses `uvx` for execution, cache files are created in the system with each run. Over time, these caches can consume significant disk space.
|
||||
|
||||
### Cache Location
|
||||
- **Windows**: `%USERPROFILE%\AppData\Local\uv\cache`
|
||||
- **macOS/Linux**: `~/.cache/uv`
|
||||
|
||||
## 🧹 Cleanup Methods
|
||||
|
||||
### Method 1: Using UV Built-in Commands (Recommended)
|
||||
|
||||
```bash
|
||||
# Check cache location
|
||||
uv cache dir
|
||||
|
||||
# Clean all cache
|
||||
uv cache clean
|
||||
```
|
||||
|
||||
### Method 2: Using Project-Provided Cleanup Tool
|
||||
|
||||
```bash
|
||||
# Check cache size
|
||||
python scripts/cleanup_cache.py --size
|
||||
|
||||
# Preview cleanup content
|
||||
python scripts/cleanup_cache.py --dry-run
|
||||
|
||||
# Execute cleanup
|
||||
python scripts/cleanup_cache.py --clean
|
||||
|
||||
# Force cleanup (attempts to close related processes)
|
||||
python scripts/cleanup_cache.py --force
|
||||
```
|
||||
|
||||
## ⚠️ Common Issues
|
||||
|
||||
### Issue: "File is being used by another process" error during cleanup
|
||||
|
||||
**Cause**: MCP server or other uvx processes are running
|
||||
|
||||
**Solutions**:
|
||||
1. **Close related processes**:
|
||||
- Close Claude Desktop or other MCP-using applications
|
||||
- Terminate all `uvx` related processes
|
||||
|
||||
2. **Use force cleanup**:
|
||||
```bash
|
||||
python scripts/cleanup_cache.py --force
|
||||
```
|
||||
|
||||
3. **Manual cleanup**:
|
||||
```bash
|
||||
# Windows
|
||||
taskkill /f /im uvx.exe
|
||||
taskkill /f /im python.exe /fi "WINDOWTITLE eq *mcp-feedback-enhanced*"
|
||||
|
||||
# Then execute cleanup
|
||||
uv cache clean
|
||||
```
|
||||
|
||||
### Issue: Cache grows large again quickly after cleanup
|
||||
|
||||
**Cause**: Frequent use of `uvx mcp-feedback-enhanced@latest`
|
||||
|
||||
**Recommendations**:
|
||||
1. **Regular cleanup**: Recommend weekly or monthly cleanup
|
||||
2. **Monitor size**: Regularly check cache size
|
||||
3. **Consider local installation**: For developers, consider local installation instead of uvx
|
||||
|
||||
## 📊 Cache Size Monitoring
|
||||
|
||||
### Check Cache Size
|
||||
|
||||
```bash
|
||||
# Using cleanup tool
|
||||
python scripts/cleanup_cache.py --size
|
||||
|
||||
# Or check directory size directly (Windows)
|
||||
dir "%USERPROFILE%\AppData\Local\uv\cache" /s
|
||||
|
||||
# macOS/Linux
|
||||
du -sh ~/.cache/uv
|
||||
```
|
||||
|
||||
### Recommended Cleanup Frequency
|
||||
|
||||
| Cache Size | Recommended Action |
|
||||
|-----------|-------------------|
|
||||
| < 100MB | No cleanup needed |
|
||||
| 100MB-500MB | Consider cleanup |
|
||||
| > 500MB | Cleanup recommended |
|
||||
| > 1GB | Cleanup strongly recommended |
|
||||
|
||||
## 🔧 Automated Cleanup
|
||||
|
||||
### Windows Scheduled Task
|
||||
|
||||
```batch
|
||||
@echo off
|
||||
cd /d "G:\github\interactive-feedback-mcp"
|
||||
python scripts/cleanup_cache.py --clean
|
||||
```
|
||||
|
||||
### macOS/Linux Cron Job
|
||||
|
||||
```bash
|
||||
# Weekly cleanup on Sunday
|
||||
0 2 * * 0 cd /path/to/interactive-feedback-mcp && python scripts/cleanup_cache.py --clean
|
||||
```
|
||||
|
||||
## 💡 Best Practices
|
||||
|
||||
1. **Regular monitoring**: Check cache size monthly
|
||||
2. **Timely cleanup**: Clean when cache exceeds 500MB
|
||||
3. **Close processes**: Ensure related MCP services are closed before cleanup
|
||||
4. **Backup important data**: Ensure important projects are backed up before cleanup
|
||||
|
||||
## 🆘 Troubleshooting
|
||||
|
||||
### Common Causes of Cleanup Failure
|
||||
|
||||
1. **Process occupation**: MCP server is running
|
||||
2. **Insufficient permissions**: Administrator privileges required
|
||||
3. **Disk errors**: File system errors
|
||||
|
||||
### Resolution Steps
|
||||
|
||||
1. Close all MCP-related processes
|
||||
2. Run cleanup command as administrator
|
||||
3. If still failing, restart computer and try again
|
||||
4. Consider manually deleting parts of cache directory
|
||||
|
||||
## 📞 Support
|
||||
|
||||
If you encounter cleanup issues, please:
|
||||
1. Check the troubleshooting section in this document
|
||||
2. Report issues on [GitHub Issues](https://github.com/Minidoracat/mcp-feedback-enhanced/issues)
|
||||
3. Provide error messages and system information
|
||||
BIN
docs/en/images/gui1.png
Normal file
|
After Width: | Height: | Size: 52 KiB |
BIN
docs/en/images/gui2.png
Normal file
|
After Width: | Height: | Size: 55 KiB |
BIN
docs/en/images/web1.png
Normal file
|
After Width: | Height: | Size: 74 KiB |
BIN
docs/en/images/web2.png
Normal file
|
After Width: | Height: | Size: 72 KiB |
142
docs/zh-CN/cache-management.md
Normal file
@@ -0,0 +1,142 @@
|
||||
# UV Cache 管理指南
|
||||
|
||||
## 🔍 问题说明
|
||||
|
||||
由于本项目使用 `uvx` 执行,每次运行都会在系统中建立 cache 文件。随着时间推移,这些 cache 可能会占用大量磁盘空间。
|
||||
|
||||
### Cache 位置
|
||||
- **Windows**: `%USERPROFILE%\AppData\Local\uv\cache`
|
||||
- **macOS/Linux**: `~/.cache/uv`
|
||||
|
||||
## 🧹 清理方法
|
||||
|
||||
### 方法一:使用 UV 内建命令(推荐)
|
||||
|
||||
```bash
|
||||
# 查看 cache 位置
|
||||
uv cache dir
|
||||
|
||||
# 清理所有 cache
|
||||
uv cache clean
|
||||
```
|
||||
|
||||
### 方法二:使用项目提供的清理工具
|
||||
|
||||
```bash
|
||||
# 查看 cache 大小
|
||||
python scripts/cleanup_cache.py --size
|
||||
|
||||
# 预览清理内容
|
||||
python scripts/cleanup_cache.py --dry-run
|
||||
|
||||
# 执行清理
|
||||
python scripts/cleanup_cache.py --clean
|
||||
|
||||
# 强制清理(会尝试关闭相关程序)
|
||||
python scripts/cleanup_cache.py --force
|
||||
```
|
||||
|
||||
## ⚠️ 常见问题
|
||||
|
||||
### 问题:清理时出现「文件正由另一个程序使用」错误
|
||||
|
||||
**原因**:有 MCP 服务器或其他 uvx 程序正在运行
|
||||
|
||||
**解决方案**:
|
||||
1. **关闭相关程序**:
|
||||
- 关闭 Claude Desktop 或其他使用 MCP 的应用
|
||||
- 结束所有 `uvx` 相关程序
|
||||
|
||||
2. **使用强制清理**:
|
||||
```bash
|
||||
python scripts/cleanup_cache.py --force
|
||||
```
|
||||
|
||||
3. **手动清理**:
|
||||
```bash
|
||||
# Windows
|
||||
taskkill /f /im uvx.exe
|
||||
taskkill /f /im python.exe /fi "WINDOWTITLE eq *mcp-feedback-enhanced*"
|
||||
|
||||
# 然后执行清理
|
||||
uv cache clean
|
||||
```
|
||||
|
||||
### 问题:清理后 cache 很快又变大
|
||||
|
||||
**原因**:频繁使用 `uvx mcp-feedback-enhanced@latest`
|
||||
|
||||
**建议**:
|
||||
1. **定期清理**:建议每周或每月清理一次
|
||||
2. **监控大小**:定期检查 cache 大小
|
||||
3. **考虑本地安装**:如果是开发者,可考虑本地安装而非每次使用 uvx
|
||||
|
||||
## 📊 Cache 大小监控
|
||||
|
||||
### 检查 Cache 大小
|
||||
|
||||
```bash
|
||||
# 使用清理工具
|
||||
python scripts/cleanup_cache.py --size
|
||||
|
||||
# 或直接查看目录大小(Windows)
|
||||
dir "%USERPROFILE%\AppData\Local\uv\cache" /s
|
||||
|
||||
# macOS/Linux
|
||||
du -sh ~/.cache/uv
|
||||
```
|
||||
|
||||
### 建议的清理频率
|
||||
|
||||
| Cache 大小 | 建议动作 |
|
||||
|-----------|---------|
|
||||
| < 100MB | 无需清理 |
|
||||
| 100MB-500MB | 可考虑清理 |
|
||||
| > 500MB | 建议清理 |
|
||||
| > 1GB | 强烈建议清理 |
|
||||
|
||||
## 🔧 自动化清理
|
||||
|
||||
### Windows 计划任务
|
||||
|
||||
```batch
|
||||
@echo off
|
||||
cd /d "G:\github\interactive-feedback-mcp"
|
||||
python scripts/cleanup_cache.py --clean
|
||||
```
|
||||
|
||||
### macOS/Linux Cron Job
|
||||
|
||||
```bash
|
||||
# 每周日清理一次
|
||||
0 2 * * 0 cd /path/to/interactive-feedback-mcp && python scripts/cleanup_cache.py --clean
|
||||
```
|
||||
|
||||
## 💡 最佳实践
|
||||
|
||||
1. **定期监控**:每月检查一次 cache 大小
|
||||
2. **适时清理**:当 cache 超过 500MB 时进行清理
|
||||
3. **关闭程序**:清理前确保关闭相关 MCP 服务
|
||||
4. **备份重要资料**:清理前确保重要项目已备份
|
||||
|
||||
## 🆘 故障排除
|
||||
|
||||
### 清理失败的常见原因
|
||||
|
||||
1. **程序占用**:MCP 服务器正在运行
|
||||
2. **权限不足**:需要管理员权限
|
||||
3. **磁盘错误**:文件系统错误
|
||||
|
||||
### 解决步骤
|
||||
|
||||
1. 关闭所有 MCP 相关程序
|
||||
2. 以管理员身份运行清理命令
|
||||
3. 如果仍然失败,重启电脑后再试
|
||||
4. 考虑手动删除部分 cache 目录
|
||||
|
||||
## 📞 支持
|
||||
|
||||
如果遇到清理问题,请:
|
||||
1. 查看本文档的故障排除部分
|
||||
2. 在 [GitHub Issues](https://github.com/Minidoracat/mcp-feedback-enhanced/issues) 报告问题
|
||||
3. 提供错误信息和系统信息
|
||||
BIN
docs/zh-CN/images/gui1.png
Normal file
|
After Width: | Height: | Size: 54 KiB |
BIN
docs/zh-CN/images/gui2.png
Normal file
|
After Width: | Height: | Size: 53 KiB |
BIN
docs/zh-CN/images/web1.png
Normal file
|
After Width: | Height: | Size: 115 KiB |
BIN
docs/zh-CN/images/web2.png
Normal file
|
After Width: | Height: | Size: 88 KiB |
142
docs/zh-TW/cache-management.md
Normal file
@@ -0,0 +1,142 @@
|
||||
# UV Cache 管理指南
|
||||
|
||||
## 🔍 問題說明
|
||||
|
||||
由於本專案使用 `uvx` 執行,每次運行都會在系統中建立 cache 檔案。隨著時間推移,這些 cache 可能會佔用大量磁碟空間。
|
||||
|
||||
### Cache 位置
|
||||
- **Windows**: `%USERPROFILE%\AppData\Local\uv\cache`
|
||||
- **macOS/Linux**: `~/.cache/uv`
|
||||
|
||||
## 🧹 清理方法
|
||||
|
||||
### 方法一:使用 UV 內建命令(推薦)
|
||||
|
||||
```bash
|
||||
# 查看 cache 位置
|
||||
uv cache dir
|
||||
|
||||
# 清理所有 cache
|
||||
uv cache clean
|
||||
```
|
||||
|
||||
### 方法二:使用專案提供的清理工具
|
||||
|
||||
```bash
|
||||
# 查看 cache 大小
|
||||
python scripts/cleanup_cache.py --size
|
||||
|
||||
# 預覽清理內容
|
||||
python scripts/cleanup_cache.py --dry-run
|
||||
|
||||
# 執行清理
|
||||
python scripts/cleanup_cache.py --clean
|
||||
|
||||
# 強制清理(會嘗試關閉相關程序)
|
||||
python scripts/cleanup_cache.py --force
|
||||
```
|
||||
|
||||
## ⚠️ 常見問題
|
||||
|
||||
### 問題:清理時出現「檔案正由另一個程序使用」錯誤
|
||||
|
||||
**原因**:有 MCP 服務器或其他 uvx 程序正在運行
|
||||
|
||||
**解決方案**:
|
||||
1. **關閉相關程序**:
|
||||
- 關閉 Claude Desktop 或其他使用 MCP 的應用
|
||||
- 結束所有 `uvx` 相關程序
|
||||
|
||||
2. **使用強制清理**:
|
||||
```bash
|
||||
python scripts/cleanup_cache.py --force
|
||||
```
|
||||
|
||||
3. **手動清理**:
|
||||
```bash
|
||||
# Windows
|
||||
taskkill /f /im uvx.exe
|
||||
taskkill /f /im python.exe /fi "WINDOWTITLE eq *mcp-feedback-enhanced*"
|
||||
|
||||
# 然後執行清理
|
||||
uv cache clean
|
||||
```
|
||||
|
||||
### 問題:清理後 cache 很快又變大
|
||||
|
||||
**原因**:頻繁使用 `uvx mcp-feedback-enhanced@latest`
|
||||
|
||||
**建議**:
|
||||
1. **定期清理**:建議每週或每月清理一次
|
||||
2. **監控大小**:定期檢查 cache 大小
|
||||
3. **考慮本地安裝**:如果是開發者,可考慮本地安裝而非每次使用 uvx
|
||||
|
||||
## 📊 Cache 大小監控
|
||||
|
||||
### 檢查 Cache 大小
|
||||
|
||||
```bash
|
||||
# 使用清理工具
|
||||
python scripts/cleanup_cache.py --size
|
||||
|
||||
# 或直接查看目錄大小(Windows)
|
||||
dir "%USERPROFILE%\AppData\Local\uv\cache" /s
|
||||
|
||||
# macOS/Linux
|
||||
du -sh ~/.cache/uv
|
||||
```
|
||||
|
||||
### 建議的清理頻率
|
||||
|
||||
| Cache 大小 | 建議動作 |
|
||||
|-----------|---------|
|
||||
| < 100MB | 無需清理 |
|
||||
| 100MB-500MB | 可考慮清理 |
|
||||
| > 500MB | 建議清理 |
|
||||
| > 1GB | 強烈建議清理 |
|
||||
|
||||
## 🔧 自動化清理
|
||||
|
||||
### Windows 排程任務
|
||||
|
||||
```batch
|
||||
@echo off
|
||||
cd /d "G:\github\interactive-feedback-mcp"
|
||||
python scripts/cleanup_cache.py --clean
|
||||
```
|
||||
|
||||
### macOS/Linux Cron Job
|
||||
|
||||
```bash
|
||||
# 每週日清理一次
|
||||
0 2 * * 0 cd /path/to/interactive-feedback-mcp && python scripts/cleanup_cache.py --clean
|
||||
```
|
||||
|
||||
## 💡 最佳實踐
|
||||
|
||||
1. **定期監控**:每月檢查一次 cache 大小
|
||||
2. **適時清理**:當 cache 超過 500MB 時進行清理
|
||||
3. **關閉程序**:清理前確保關閉相關 MCP 服務
|
||||
4. **備份重要資料**:清理前確保重要專案已備份
|
||||
|
||||
## 🆘 故障排除
|
||||
|
||||
### 清理失敗的常見原因
|
||||
|
||||
1. **程序佔用**:MCP 服務器正在運行
|
||||
2. **權限不足**:需要管理員權限
|
||||
3. **磁碟錯誤**:檔案系統錯誤
|
||||
|
||||
### 解決步驟
|
||||
|
||||
1. 關閉所有 MCP 相關程序
|
||||
2. 以管理員身份運行清理命令
|
||||
3. 如果仍然失敗,重啟電腦後再試
|
||||
4. 考慮手動刪除部分 cache 目錄
|
||||
|
||||
## 📞 支援
|
||||
|
||||
如果遇到清理問題,請:
|
||||
1. 查看本文檔的故障排除部分
|
||||
2. 在 [GitHub Issues](https://github.com/Minidoracat/mcp-feedback-enhanced/issues) 回報問題
|
||||
3. 提供錯誤訊息和系統資訊
|
||||
BIN
docs/zh-TW/images/gui1.png
Normal file
|
After Width: | Height: | Size: 54 KiB |
BIN
docs/zh-TW/images/gui2.png
Normal file
|
After Width: | Height: | Size: 53 KiB |
BIN
docs/zh-TW/images/web1.png
Normal file
|
After Width: | Height: | Size: 115 KiB |
BIN
docs/zh-TW/images/web2.png
Normal file
|
After Width: | Height: | Size: 88 KiB |