# LanCourier

**Repository Path**: mushyuki/LanCourier

## Basic Information

- **Project Name**: LanCourier
- **Description**: LanCourier 是一款面向 Windows 的局域网文件传输工具，支持通过 SSH/SFTP 将文件或目录快速发送到远程机器。它提供多目标配置、拖拽添加、传输队列、暂停/继续、带宽限制、日志、历史记录、局域网设备发现和系统托盘常驻等功能，适合在多台服务器或设备之间进行稳定、可追踪的文件传输。
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-04
- **Last Updated**: 2026-05-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# LanCourier

LanCourier 是一个 Windows 优先的局域网文件传输工具。它使用 Tauri + React 提供桌面界面，使用本地 FastAPI agent 管理 SFTP 连接、传输队列、历史记录和日志。

特色：
[鼠标右键文件即可发送](docs/88e1713f-45e3-4baf-8aa3-08ba28f63895.png)

## 技术栈!

- 前端：React + Vite + Tauri 2
- 桌面集成：Rust / Tauri，支持右键参数接收、后台 agent 启动、系统托盘
- 后端 agent：Python + FastAPI + Paramiko
- 传输协议：SSH/SFTP

## 开发环境

前端需要 Node.js、pnpm 和 Rust 工具链。后端需要 Python。

```powershell
rustc -V
cargo -V
python --version
pnpm --version
```

## 启动方式

```powershell
# 后端 agent
cd agent
python main.py

# 前端开发服务
cd frontend
pnpm dev

# Tauri 桌面开发
cd frontend
pnpm tauri dev
```

运行端口：

- Agent HTTP/WebSocket：`127.0.0.1:38471`
- Vite dev server：`127.0.0.1:1420`

## 打包

Windows 环境下使用：

```powershell
.\build.ps1
```

## 当前功能

- SSH 连接配置保存和加载
- 多传输目标配置、分组、测试连接
- 密码和 SSH 私钥认证
- SFTP 文件和目录上传，目录结构保持
- 传输队列管理
- 单任务暂停、继续、终止
- `.part` 临时文件和断点续传
- 进度、速度、剩余时间显示
- 带宽限制
- 传输历史记录
- agent 日志记录和界面查看
- 拖拽添加文件
- Explorer 右键菜单参数接收
- Tauri 自动启动 agent
- 系统托盘显示、隐藏、退出
- NSIS 安装包配置

## 文档

- [项目总览](docs/PROJECT_OVERVIEW.md)
- [功能模块](docs/FEATURES.md)
- [功能实现报告](docs/FUNCTION_REPORT.md)
- [传输设计](docs/TRANSFER_DESIGN.md)
- [API 与 WebSocket](docs/API.md)
- [配置、历史和日志](docs/CONFIG_AND_HISTORY.md)
- [路线图](docs/ROADMAP.md)
- [暂停/恢复/终止说明](PAUSE_RESUME_FEATURE.md)

## 验证命令

```powershell
cd agent
python -m pytest tests -q

cd ..\frontend
pnpm build

cd src-tauri
cargo test
```