# @topnet/cli

> topnet-cli是一个可以通过命令行快速选择模板，初始化项目的脚手架工具。

Latest version **1.0.5** (published 2021-07-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install @topnet/cli
pnpm add @topnet/cli
yarn add @topnet/cli
bun add @topnet/cli
```

Provides the command `topnet`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2021-07-23 |
| First published | 2021-07-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 19 |
| Unpacked size | 23.5 KB |
| Known vulnerabilities | 0 (+11 in 4 direct dependencies) |
| Install scripts | no |
| Author | hk5518 |
| Maintainers | hk5518 |
| Keywords | topnet |

## Links

- npm: https://www.npmjs.com/package/@topnet/cli
- npm.io page: https://npm.io/package/@topnet/cli

## Dependencies (19)

- [ejs](https://npm.io/package/ejs.md) ^3.1.3
- [ora](https://npm.io/package/ora.md) ^4.0.4
- [open](https://npm.io/package/open.md) ^7.0.4
- [scp2](https://npm.io/package/scp2.md) ^0.5.0
- [ssh2](https://npm.io/package/ssh2.md) ^0.8.9
- [chalk](https://npm.io/package/chalk.md) ^4.0.0
- [clear](https://npm.io/package/clear.md) ^0.1.0
- [figlet](https://npm.io/package/figlet.md) ^1.4.0
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [adm-zip](https://npm.io/package/adm-zip.md) ^0.5.5
- [request](https://npm.io/package/request.md) ^2.88.2
- [download](https://npm.io/package/download.md) ^8.0.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.0
- [inquirer](https://npm.io/package/inquirer.md) ^7.1.0
- [commander](https://npm.io/package/commander.md) ^5.1.0
- [git-clone](https://npm.io/package/git-clone.md) ^0.1.0
- [consolidate](https://npm.io/package/consolidate.md) ^0.15.1
- [cross-spawn](https://npm.io/package/cross-spawn.md) ^7.0.2
- [log-symbols](https://npm.io/package/log-symbols.md) ^4.0.0

## Recent versions

- 1.0.5 (latest) — 2021-07-23

## README

## topnet-cli 初始化项目脚手架工具

### 一、概述

@topnet/cli 是一个可以通过命令行快速选择模板，初始化项目的脚手架工具，目的是解决
前端项目模板的拷贝问题、，支持选择 github、gitlab 的项目模板进行创建。

### 二、使用

1、安装 nodejs 到 [nodejs 官网](https://nodejs.org/en/)下载对应的 nodejs 包进行
安装。

2、安装 @topnet/cli 脚手架

```
npm i @topnet/cli -g
```

3、打开系统命令行工具，检测 topnet 环境

```
查看版本
topnet -V  或  topnet --version

查看帮助
topnet -h 或 topnet --help
```

4、初始化项目

```
topnet create [projectName] // [projectName]为可选参数
```

5、列出模板

```
topnet ls
```

6、设置模板

```
topnet set <templateName> <templateRepo> // <templateName> <templateRepo>为必选参数
```

7、删除模板

```
topnet unset <templateName> // <templateName>为必选参数
```

8、拷贝项目

```
topnet copy <sourceDir> <targetDir> // <sourceDir> <targetDir>为必选参数
```

9、发布静态资源到服务器

```
9.1、命令
topnet deploy <source> // <source>为必选参数

9.2、项目根目录deploy.json的配置
{
    "host": "******", // 可为空
    "port": "******", // 可为空
    "username": "******", // 可为空
    "password": "******", // 可为空
    "path": "******",
    "localPath": "dist"
}
```

### 三、注意事项

Q1：在 powershell 中执行 topnet -h 的命令时，可能会出现如下错误：

```
topnet : 无法加载文件 C:\Users\Administrator.WIN-IPTBEDC2HPI\AppData\Roaming\npm\topnet.ps1，因为在此系统上禁止运行脚本。
```

A1：解决方法：以管理员身份，打开 powershell，执行如下命令后选择 “Y”

```
set-ExecutionPolicy RemoteSigned
```

---
_Source: https://npm.io/package/@topnet/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._