https://github.com/warmthsea/scripts-deploy
Use scripts to quick deploy your build files.
https://github.com/warmthsea/scripts-deploy
build deploy dist fs react script ssh ssh-client ssh-server vue
Last synced: 5 months ago
JSON representation
Use scripts to quick deploy your build files.
- Host: GitHub
- URL: https://github.com/warmthsea/scripts-deploy
- Owner: warmthsea
- License: mit
- Created: 2024-07-19T02:41:43.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-10-31T07:27:10.000Z (8 months ago)
- Last Synced: 2025-02-06T12:49:13.482Z (5 months ago)
- Topics: build, deploy, dist, fs, react, script, ssh, ssh-client, ssh-server, vue
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/scripts-deploy
- Size: 466 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# scripts-deploy
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![JSDocs][jsdocs-src]][jsdocs-href]
[![License][license-src]][license-href]
Use scripts to quick deploy your build files.
## 📦 Install
```shell
pnpm i scripts-deploy -D
```
If install warning, you can use `pnpm i scripts-deploy -D --ignore-scripts`
## 🦄 Usage
#### Open cmd, Init `deploy.config` file and write it
```shell
deploy init
```
Show examples
```js
export default {
host: '192.xxx',
port: 10022,
username: 'xxx',
password: 'xxx',
wwwPath: '/usr/xxx/xxx',
rootDir: '/dist',
confirm: true
}
```
Show types
```ts
export interface ScriptsDeployOption {
/** Server host */
host: string
/** Server post */
port: number
/** Server login username */
username: string
/** Server login password */
password: string
/** Server folder path */
wwwPath: string
/** Build output folder */
rootDir: string
/** Confirm execution */
confirm?: boolean
/** Number of concurrent uploads, Default is 15 */
limit?: number
}
```
[See file](https://github.com/warmthsea/scripts-deploy/blob/main/src/type.ts)
#### Run
```shell
deploy
```
## License
[MIT](./LICENSE) License © 2024-PRESENT [warmthsea](https://github.com/warmthsea)
[npm-version-src]: https://img.shields.io/npm/v/scripts-deploy?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/scripts-deploy
[npm-downloads-src]: https://img.shields.io/npm/dm/scripts-deploy?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/scripts-deploy
[license-src]: https://img.shields.io/github/license/warmthsea/scripts-deploy.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/warmthsea/scripts-deploy/blob/main/LICENSE
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
[jsdocs-href]: https://www.jsdocs.io/package/scripts-deploy