# nc

**Repository Path**: node-message/nc

## Basic Information

- **Project Name**: nc
- **Description**: No description available
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-20
- **Last Updated**: 2026-08-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# nc — 多语言脚手架 + 系统运维 CLI

## 安装

```bash
npm install -g nc
```

## 命令概览

| 命令 | 别名 | 说明 |
|------|------|------|
| `nc scaffold` | `sc` | 项目脚手架管理 |
| `nc project` | `p` | 项目管理 |
| `nc http` | `serve` | 静态文件 HTTP 服务 |
| `nc env` | `e` | 用户环境变量管理 |
| `nc kill` | `k` | 通过端口/PID 杀死进程 |
| `nc hosts` | `h` | hosts 文件管理 |
| `nc doctor` | `dr` | 检查系统环境依赖 |
| `nc covers` | `cv` | 文件转换（PDF→图片 / 图片缩放压缩 / Markdown→HTML / 图片信息） |

---

## nc scaffold — 项目脚手架

交互式从模板创建项目脚手架。

```bash
nc scaffold create      # 交互式创建项目
nc scaffold list [搜索]  # 浏览/搜索模板并创建
# 别名
nc sc c
nc sc l [搜索]
```

流程：选择类型 → 选择模板 → 输入项目名称 → 自动克隆模板仓库。

支持模板：（可通过 `nc sc l` 交互式浏览）

| 类型 | 框架 |
|------|------|
| Node.js | Express / Koa / NestJS / Fastify |
| Python | Django / Flask / FastAPI |
| Java | RuoYi / Quarkus / Micronaut |
| Go | Gin / Chi / Echo / Fiber |
| Rust | Axum / Actix / Rocket / Tide |
| C#/.NET | ASP.NET Core / Blazor / .NET MAUI |
| PHP | Laravel / Symfony / ThinkPHP |
| Ruby | Ruby on Rails / Sinatra |
| Kotlin | Spring Boot / Ktor |
| Dart/Flutter | souer-flutter |

---

## nc project — 项目管理

在项目根目录下初始化 `.nc/nc.json` 配置文件，管理项目的启动、停止、运行等。

### 项目配置

```bash
nc project init              # 初始化当前目录为项目
nc project load              # 同步 .nc/nc.json 到数据库
nc project info              # 查看当前项目详情
nc project rename            # 修改项目名称
```

### 项目浏览

```bash
nc project list [query]      # 交互式列表（支持名称模糊搜索）
nc project open <target>     # 打开项目文件夹
nc project ps                # 查看所有项目进程状态
```

### 项目运行

```bash
nc project start [target]    # 启动项目（-a 全部启动）
nc project stop <target>     # 停止项目（-f 强制）
nc project restart [target]  # 重启项目（-a 全部重启）
nc project run [script]      # 执行配置的脚本
```

### 项目管理

```bash
nc project rm <target>       # 从管理列表移除（逻辑删除）
```

#### 配置示例 (.nc/nc.json)

```json
{
  "name": "my-app",
  "type": "node",
  "scripts": {
    "start": "npm start",
    "dev": "npm run dev",
    "build": "npm run build"
  }
}
```

---

## nc env — 环境变量管理

持久化用户环境变量，支持 Windows（注册表）和 Unix（shell rc 文件）。

```bash
nc env list [prefix]         # 交互式浏览环境变量
nc env get <key>             # 获取环境变量值
nc env set <key> <value>     # 设置持久化环境变量
nc env rm <key>              # 删除环境变量
```

---

## nc kill — 进程管理

通过端口号或 PID 杀死进程，跨平台支持。

```bash
nc kill --port 3000          # 杀死占用 3000 端口的进程
nc kill --pid 1234           # 杀死指定 PID 的进程
nc kill --port 3000 -f       # 强制杀死
```

## nc http — 静态文件服务

快速启动 HTTP 静态文件服务器，支持 SPA 模式、目录列表、自定义前缀等。

```bash
nc http                              # 默认端口 8080
nc serve -p 3000                     # 指定端口
nc http -d ./dist                    # 指定根目录
nc http --spa                        # SPA 模式（404 返回 index.html）
nc http -s                           # 启用目录文件列表展示
nc http --prefix /app                # 设置访问前缀
nc http -t index.htm index.html      # 自定义默认文件顺序
nc http --log false                  # 关闭请求日志
```

选项：

| 选项 | 别名 | 说明 |
|------|------|------|
| `--port` | `-p` | 监听端口（默认 8080） |
| `--host` | | 监听地址（默认 0.0.0.0） |
| `--dir` | `-d` | 服务根目录（默认当前目录） |
| `--static` | `-s` | 启用目录文件列表展示 |
| `--tryfile` | `-t` | 目录默认文件列表（可指定多个） |
| `--log` | | 请求日志（默认 true） |
| `--spa` | | SPA 模式（所有 404 返回 index.html） |
| `--prefix` | | 访问前缀（如 /app） |

---

## nc hosts — hosts 文件管理

管理系统 hosts 文件条目（需要管理员权限）。

```bash
nc hosts list                      # 交互式管理（支持编辑、删除、新增）
nc hosts add <ip> <host>           # 添加条目
nc hosts rm <host>                 # 删除条目
```

---

## nc doctor — 系统环境检查

检查系统依赖是否满足运行条件。

```bash
nc doctor
# 或
nc dr
```

检查项：
- **Git** — 是否已安装及版本号
- **Node.js** — 版本是否 ≥ v18

---

## nc covers — 文件转换

PDF 转图片、图片缩放压缩、Markdown 转 HTML。

```bash
nc covers pdf <file.pdf>                  # PDF → PNG（默认 2x 缩放，输出到 <name>-img/）
nc covers pdf doc.pdf -f jpeg -s 3        # 输出 JPEG，3 倍缩放
nc covers pdf doc.pdf -p 1-3,5            # 只转 1、2、3、5 页
nc covers pdf doc.pdf -o ./out -q 85      # 指定输出目录与 JPEG 质量

nc covers image photo.png -w 800          # 缩放宽度 800（高度等比）
nc covers image photo.png -p 50           # 缩放 50%
nc covers image photo.png -f webp -q 80   # 格式转换 + 质量压缩

nc covers md readme.md                    # Markdown → readme.html（内置样式）
nc covers md readme.md -o out.html -t 标题 -c style.css

nc covers info photo.png                  # 查看图片信息（格式/尺寸/体积）
```

| 子命令 | 说明 | 常用选项 |
|--------|------|---------|
| `covers pdf` | PDF 转 PNG/JPEG | `-f png\|jpeg`、`-s 缩放倍数`、`-p 页码(如 1-3,5)`、`-o 目录`、`-q 质量` |
| `covers image` | 图片缩放/压缩/转格式 | `-w 宽`、`-H 高`、`-p 百分比`、`-f png\|jpeg\|webp\|gif`、`-q 质量`、`-o 路径` |
| `covers md` | Markdown 转 HTML | `-o 路径`、`-t 标题`、`-c 自定义 CSS` |
| `covers info` | 查看图片信息 | 支持 PNG/JPEG/GIF/WebP/BMP，显示格式、尺寸、像素、位深、体积 |

---

## 数据存储

数据存储在 `~/.nc/db.sqlite`（SQLite 数据库），包含项目注册信息。