{"_id":"@boyuai/static-deploy-tool","_rev":"1-4b5763fb2cbd02ff9f334a7ac965d0da","name":"@boyuai/static-deploy-tool","dist-tags":{"latest":"1.3.0"},"versions":{"1.3.0":{"name":"@boyuai/static-deploy-tool","version":"1.3.0","bin":{"static-deploy-tool":"cli.js"},"repository":{"type":"git","url":"git+ssh://git@github.com/wangsijie/static-deploy-tool.git"},"author":{"name":"wangsijie","email":"i@sijie.wang"},"license":"MIT","dependencies":{"ali-oss":"^6.5.1","commander":"^4.1.1","md5-file":"^4.0.0"},"devDependencies":{"@types/ali-oss":"^6.0.8","@types/jest":"^26.0.22","dotenv":"^8.2.0","jest":"^26.6.3"},"scripts":{"test":"jest"},"gitHead":"75153f65d8b9ba4c814512093daafdc8c6813384","description":"静态文件部署工具，一条命令自动部署文件夹或大文件到阿里云OSS","bugs":{"url":"https://github.com/wangsijie/static-deploy-tool/issues"},"homepage":"https://github.com/wangsijie/static-deploy-tool#readme","_id":"@boyuai/static-deploy-tool@1.3.0","_nodeVersion":"14.17.4","_npmVersion":"6.14.14","dist":{"integrity":"sha512-e1Qdo8SjPHOWbkJ/+wJvk2QQH2qSpv9Hm47lqBGphPePKElHhzKEJQ6fIrOlH/Ut3pYYDqM47D8q3CRCmWdd+A==","shasum":"af559e3d5b4e1e5709b47cde3320fee2dc519eee","tarball":"https://registry.npmjs.org/@boyuai/static-deploy-tool/-/static-deploy-tool-1.3.0.tgz","fileCount":13,"unpackedSize":13356,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhQGKYCRA9TVsSAnZWagAAzHkQAISs73kM26yTV6Lw3g7E\nBMaEHYqkTb7zLmCaT3GeKnqeZvlcuy0bagzqPe5X3+1D6DhIUqCf8FXHir5o\nS8ivQaUkSM8Jr0LHi80ZVwSFVLt1joyndBQiYd9e75nFzKK2bAoDYH/beCEO\n4WaoKVS0kCKF8wTiXzb5UHd1hUi6+hMHDxnoV7JAZ8uffTFFRzJ+usRfdals\n6fhPwA/TKCb0+hdbmjlDaA/KhpeInnPqpUaoVO62zawHb1fAigmahyUa1sxV\ng9/hHFhDcRsRumYRO+KnRUFVNjETHjamme1+XtoAUZGG/M0HFjElofXW9WHq\netrYBLxp9JmJGtk/BurucUdkGUneJ/eBGTbjTMVdw4evExDWq6/Y1tYA/0e2\nFesBwVKGrCPPCzlr4MaF6/r0JCcjhIDoUTyFSnDp7mfZ5fplNCBXmO2fXs8S\n6HQK8taRUijKPi9pi33x8lJi5jmMKTg0rqUvNniU7V8dsgxB4Dt9Pzl2saw3\nLvde297JA4flnM/lXaWcUraBWCZ+cja2bNfzwGMccSy3AfJFIf5oY7FI8Ady\n5NKLBV6Lz6UdSpr848/bAx3flwxHGS7zPC5lcYki1GyRlQW9XvFngG8uNNxx\nRKtFID3q+IOYKvZCIkd3Qp2pGBReUMF/Jpmnx4eqA0PPR/AfcAnkAgR/6hGT\nnCY1\r\n=yVI1\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDfcJ65A+oV1iouboVJxAULCfkWjchXKnf5HyT/70RzwQIhAJYWAx0VvRR5J1qRhXSu6r5MIGIi4Y1LK4kWeNrZKW+H"}]},"_npmUser":{"name":"qianyue","email":"xiangyujames@gmail.com"},"directories":{},"maintainers":[{"name":"wangsijie","email":"i@sijie.wang"},{"name":"tripley","email":"keanever@outlook.com"},{"name":"weiyichong","email":"864147974@qq.com"},{"name":"qianyue","email":"xiangyujames@gmail.com"},{"name":"helsonxiao","email":"helsonxiao@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/static-deploy-tool_1.3.0_1631609496566_0.10108259030448807"},"_hasShrinkwrap":false}},"time":{"created":"2021-09-14T08:51:36.518Z","1.3.0":"2021-09-14T08:51:36.682Z","modified":"2022-04-04T20:18:35.438Z"},"maintainers":[{"name":"wangsijie","email":"i@sijie.wang"},{"name":"tripley","email":"keanever@outlook.com"},{"name":"weiyichong","email":"864147974@qq.com"},{"name":"qianyue","email":"xiangyujames@gmail.com"},{"name":"helsonxiao","email":"helsonxiao@gmail.com"}],"description":"静态文件部署工具，一条命令自动部署文件夹或大文件到阿里云OSS","homepage":"https://github.com/wangsijie/static-deploy-tool#readme","repository":{"type":"git","url":"git+ssh://git@github.com/wangsijie/static-deploy-tool.git"},"author":{"name":"wangsijie","email":"i@sijie.wang"},"bugs":{"url":"https://github.com/wangsijie/static-deploy-tool/issues"},"license":"MIT","readme":"# static-deploy-tool\r\n\r\n静态文件部署工具，一条命令自动部署文件夹或大文件到阿里云OSS\r\n\r\n## 安装\r\n\r\n全局安装\r\n\r\n```\r\nnpm i -g static-deploy-tool\r\n```\r\n\r\n也可以直接使用npx，无需安装\r\n\r\n## 常用命令\r\n\r\n### 同步文件夹到远程\r\n\r\n```bash\r\nsync <local> <remote>\r\n```\r\n\r\n同步本地build文件夹到远程Bucket: my-bucket下的production/home文件夹\r\n\r\n```bash\r\nstatic-deploy-tool sync build production/home -k LTAI4Fnxxxxx -s 1wWQo9JQpSxxxx -b my-bucket\r\n```\r\n\r\n该命令会首先逐个上传本地文件到远程目录，并根据md5比对跳过已有文件。之后**删除**远程存在但本地没有的文件。\r\n\r\n如果包含`index.html`或`index.htm`文件，则这类文件会在最后被上传，确保所以资源上传完毕后再更新index\r\n\r\n### 上传大文件到远程\r\n\r\n```bash\r\nput <local> <remote>\r\n```\r\n\r\n使用分片上传的方式，将本地build/code.tar.gz文件上传到远程\r\n\r\n```bash\r\nstatic-deploy-tool put build/code.tar.gz production/code.tar.gz -k LTAI4Fnxxxxx -s 1wWQo9JQpSxxxx -b my-bucket\r\n```\r\n\r\n将会展示上传进度百分比，并且对于错误的分片自动重试\r\n\r\n### 复制远程文件\r\n\r\n```bash\r\ncopy <source> <dest>\r\n```\r\n\r\n复制远程文件`platform/sandbox/latest.tar.gz`到`platform/production/latest.tar.gz`\r\n\r\n```bash\r\nstatic-deploy-tool copy platform/sandbox/latest.tar.gz platform/production/latest.tar.gz -k LTAI4Fnxxxxx -s 1wWQo9JQpSxxxx -b my-bucket\r\n```\r\n\r\n## 配置\r\n\r\n```bash\r\n$ node cli --help\r\nOptions:\r\n  -V, --version              output the version number\r\n  -k, --ak [ak]              Access Key Id\r\n  -s, --sk [sk]              Secret Access Key\r\n  -r, --region [region]      Region\r\n  -b, --bucket [bucket]      Bucket\r\n  -e, --endpoint [endpoint]  Optional, will override region setting\r\n  -h, --help                 output usage information\r\n```\r\n\r\n### 环境变量\r\n\r\n除了用参数，也可以用环境变量\r\n\r\n```\r\nOSS_AK 等同于 --ak\r\nOSS_SK 等同于 --sk\r\nOSS_REGION 等同于 --region\r\nOSS_BUCKET 等同于 --bucket\r\nOSS_ENDPOINT 等同于 --endpoint\r\n```\r\n\r\n### 阿里云内网加速\r\n\r\n指定endpoint参数为内网地址\r\n\r\n```bash\r\nstatic-deploy-tool sync build production/home -k LTAI4Fnxxxxx -s 1wWQo9JQpSxxxx -b my-bucket -e oss-cn-shanghai-internal.aliyuncs.com\r\n```\r\n\r\n### 全球加速\r\n\r\n用于GitHub Actions等国外服务传文件回国内有奇效，指定endpoint为oss-accelerate.aliyuncs.com\r\n\r\n**需要开通这个Bucket的全球加速功能**\r\n\r\n```bash\r\nstatic-deploy-tool sync build production/home -k LTAI4Fnxxxxx -s 1wWQo9JQpSxxxx -b my-bucket -e oss-accelerate.aliyuncs.com\r\n```\r\n\r\n## 使用 Github Action\r\n\r\n```yaml\r\n- uses: wangsijie/static-deploy-tool@v1\r\n  with:\r\n    oss-ak: ${{ secrets.OSS_AK }}\r\n    oss-sk: ${{ secrets.OSS_SK }}\r\n    oss-region: ${{ secrets.OSS_REGION }}\r\n    oss-bucket: ${{ secrets.OSS_BUCKET }}\r\n    oss-endpoint: oss-accelerate.aliyuncs.com\r\n    local-path: __tests__/files\r\n    remote-path: static-deploy-tool-test/action-sync\r\n```\r\n","readmeFilename":"README.md"}