From 75ec42768eec5772c18e275d2046e964818eedef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9C=B1=E6=BD=AE?= Date: Sun, 10 Aug 2025 14:07:14 +0800 Subject: [PATCH] readme --- README.md | 75 ++++++++++++++++++++++++++----------------------------- start.sh | 10 ++++---- 2 files changed, 40 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index bb0da93..56909a7 100644 --- a/README.md +++ b/README.md @@ -138,28 +138,33 @@ curl -O "http://localhost:8000/api/download/ABCD1234" curl "http://localhost:8000/api/info/ABCD1234" ``` -### 🐍 Python命令行工具(可选) +### @fileshare/fileshare_functions.sh -如果需要更丰富的功能,可以使用Python CLI工具: +便捷的Shell函数库,提供更丰富的功能: ```bash -# 安装依赖 -pip install -r requirements.txt +# 加载便捷函数 +source fileshare_functions.sh -# 上传文件 -python cli.py upload example.txt +# 现在可以使用超级简单的命令 +upload photo.jpg # 上传文件 +share_text "Hello World!" # 分享文本 +download AB12CD34 # 下载文件 +info AB12CD34 # 查看信息 +list_shares # 列出分享 -# 分享文本 -python cli.py share-text -t "Hello World!" - -# 下载文件 -python cli.py download ABCD1234 - -# 查看信息 -python cli.py info ABCD1234 +# 高级功能 +batch_upload *.jpg # 批量上传 +share_file config.txt # 分享文件内容 +set_server https://domain.com # 设置服务器 ``` -**注意**: 对于简单使用,推荐使用curl命令,无需安装Python依赖。 +**便捷功能**: +- ✅ 自动提取分享码 +- ✅ 彩色输出和错误提示 +- ✅ 支持批量操作 +- ✅ 自动服务器检测 +- ✅ 无需安装依赖 ### 环境变量配置 @@ -216,7 +221,6 @@ python cli.py info ABCD1234 ``` fileshare/ ├── app.py # 主应用程序 -├── cli.py # 命令行工具 ├── requirements.txt # Python依赖 ├── Dockerfile # Docker镜像 (标准版) ├── Dockerfile.multi # Docker镜像 (多阶段构建优化版) @@ -233,12 +237,10 @@ fileshare/ │ ├── app.js # 前端逻辑 │ └── curl-guide.html # curl命令教程页面 ├── uploads/ # 上传文件目录 -├── test_server.py # 服务测试脚本 -├── fix_paths.py # 路径修复工具 -├── verify_setup.sh # 环境验证脚本 -├── curl_examples.sh # curl使用示例 ├── fileshare_functions.sh # Shell便捷函数 -└── demo.sh # 功能演示脚本 +└── data/ # 数据目录 + ├── uploads/ # 持久化上传目录 + └── logs/ # 日志目录 ``` ### 开发模式 @@ -255,9 +257,10 @@ python app.py uvicorn app:app --reload --host 0.0.0.0 --port 8000 ``` -3. 测试CLI工具: +3. 测试便捷函数: ```bash -python cli.py --help +source fileshare_functions.sh +fileshare_help ``` ### 国内加速部署 @@ -284,17 +287,17 @@ docker-compose -f docker-compose.aliyun.yml up -d ### 🔧 快速诊断 -遇到问题时,首先运行验证脚本: +遇到问题时,可以检查服务状态: ```bash -./verify_setup.sh +docker-compose ps +docker-compose logs -f ``` ### 常见问题 1. **CSS/JS文件404错误** - ```bash - python fix_paths.py # 修复静态资源路径 - ``` + - 检查static目录是否存在 + - 确认静态文件路径正确 2. **文件上传失败** - 检查文件大小是否超过限制 @@ -317,19 +320,11 @@ docker-compose -f docker-compose.aliyun.yml up -d ```bash # 服务验证 -./verify_setup.sh +curl http://localhost:8000/api -# 功能演示(推荐) -./demo.sh - -# 运行时测试 -python test_server.py - -# 查看示例 -./curl_examples.sh - -# 路径修复 -python fix_paths.py +# 功能测试 +source fileshare_functions.sh +fileshare_help ``` ### 日志查看 diff --git a/start.sh b/start.sh index acb8a9a..164c113 100755 --- a/start.sh +++ b/start.sh @@ -51,11 +51,11 @@ if docker-compose ps | grep -q "Up"; then echo " - 停止服务: docker-compose down" echo " - 重启服务: docker-compose restart" echo - echo "💻 CLI工具使用:" - echo " - 安装依赖: pip install -r requirements.txt" - echo " - 上传文件: python cli.py upload <文件路径>" - echo " - 分享文本: python cli.py share-text -t '内容'" - echo " - 下载文件: python cli.py download <分享码>" + echo "💻 便捷函数使用:" + echo " - 加载函数: source fileshare_functions.sh" + echo " - 上传文件: upload <文件路径>" + echo " - 分享文本: share_text '内容'" + echo " - 下载文件: download <分享码>" else echo "❌ 服务启动失败,请检查日志:" docker-compose logs