@kkkwww/fast-deploy
v1.0.9
Published
简易部署工具
Downloads
106
Readme
fast-deploy
🔥 轻量、高效、多线程 SFTP 自动化部署工具
一行命令上传项目到服务器,支持配置缓存、自动备份、自定义端口
✨ 特性
- 🚀 多线程并发上传,上传速度大幅提升
- 🔌 支持自定义端口(默认 22)
- 💾 配置自动缓存,一次配置,后续一键部署
- 📦 上传前自动备份远程目录,安全不丢失
- 📊 实时上传进度显示
- 🌍 全平台支持(Windows / macOS / Linux)
- 🛠️ 全局命令调用,安装后直接使用
fast-deploy - 📦 可直接发布到 npm
📦 安装
# 全局安装(推荐)
npm install -g fast-deploy🚀 快速使用
首次使用(完整参数)
fast-deploy --host=192.168.1.100 --port=22 --user=root --password=123456 --local=./dist --remote=/www/project后续使用(配置已缓存)
fast-deploy --local=./dist关闭自动备份
fast-deploy --local=./dist --backup=false查看版本
fast-deploy -v
# 或
fast-deploy --version📖 命令参数
| 参数 | 说明 |
|------|------|
| --host | 服务器 IP / 域名 |
| --port | SFTP 端口(默认 22) |
| --user | 服务器登录用户名 |
| --password | 服务器登录密码 |
| --local | 本地需要上传的目录 / 文件(必填) |
| --remote | 服务器目标路径 |
| --backup | 是否自动备份远程目录(默认 true) |
| -v, --version | 查看版本号 |
🏗 项目结构
├── src/ # TypeScript 源码
├── lib/ # 编译输出目录
├── package.json
├── tsconfig.json
└── README.md🔨 本地开发 & 编译
# 安装依赖
npm install
# 编译 TypeScript
npm run build📦 发布到 npm
npm run build
npm login
npm publish📌 重要说明
- 配置缓存文件保存在用户目录:
~/.fast-deploy-cache.json - 默认并发上传数:5,可在源码中修改
- 支持目录递归上传
- 上传前自动备份,避免覆盖丢失
📄 License
MIT
👨💻 作者
kkw
简易高效的项目自动化部署工具
