# devset 中文文档

规范地址：https://npmcn.com/package/devset/

版本：1\.0\.3
npm 元数据更新时间：2026-11-03T09:48:53.059Z
中文译文更新时间：2026-11-03T11:49:08.407Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/devset
原文对照：https://npmcn.com/package/devset/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：899 kB，61 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：9 个
- 首次发布：2026-11-03T07:01:11.794Z
- 最新版本发布：2026-11-03T09:48:52.908Z
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

通用的，基于规则的项目分析和自动化环境设置工具

## 安装

```sh
npm install devset
```

也可以使用：`pnpm add devset`、`yarn add devset`、`bun add devset`

## README

# DevSet CLI

> **一个命令。完成设置。**  
> 通用的，确定性的，基于规则的项目分析和自动化环境设置工具。

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://npmcn.com/package/devset/LICENSE) [![Node.js](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen.svg)](https://nodejs.org/) [![TypeScript](https://img.shields.io/badge/TypeScript-5.8-blue.svg)](https://www.typescriptlang.org/) [![Vitest](https://img.shields.io/badge/Tested%20with-Vitest-729B1B.svg)](https://vitest.dev/) ![Zero AI](https://img.shields.io/badge/AI-100%25%20Rule--Based%20%26%20Local-purple.svg)

* * *

## 这个问题

每当开发人员克隆一个全栈存储库或多服务代码库时，他们通常花费30-60分钟：

1.  找出当前存在哪些编程语言和框架。
2.  定位嵌套的前端和后端清单。
3.  在冲突的包管理器（npm, yarn, pnpm, bun）之间进行选择。
4.  创建和激活跨Windows/macOS/Linux的Python虚拟环境。
5.  识别缺失的环境变量。
6.  打开多个终端以单独启动每个服务。

**DevSet CLI安全、本地和确定地自动化整个工作流程。**

```bash
# Clone any repo
git clone https://github.com/example/fullstack-app.git
cd fullstack-app

# Run DevSet
npx devset-cli

# Start all services together
npm run dev:all
```

* * *

## 关键特性

-   **100%基于规则和本地**：在项目分析期间，零AI、零外部api、零令牌和零网络调用。完全离线工作。
-   **深度多层检测**：在单片和多目录存储库中识别独立组件（前端、后端、管理、微服务）。
-   **确定性包管理**：自动执行锁定文件(`npm ci`， `yarn install --frozen-lockfile`， `pnpm install --frozen-lockfile`， `bun install --frozen-lockfile`)，并在冲突的锁文件上发出警报。
-   **隔离的Python虚拟环境**：自动创建 `.venv` 在Windows (`.venv\Scripts\python.exe`)及POSIX (`.venv/bin/python`)，在不污染系统Python的情况下在虚拟环境中安装依赖项。
-   **安全环境审计**:比较 `.env.example` 反对 `.env` 突出显示缺失的键 **而不会暴露秘密值**。
-   **通用多用途流道**： `devset run` 使用格式化的彩色前缀日志并发地启动前端和后端服务(`[FRONTEND]`， `[BACKEND]`)，实时URL检测，以及优雅的进程树终止 `Ctrl+C`。
-   **安全模拟**:内置 `--dry-run` 标记为预览设置步骤而不进行更改。
-   **系统的医生**:内置 `devset doctor` 安装运行时（Node, Python, Java, Docker, Git）的诊断。

* * *

## 终端的经验

```text
╔════════════════════════════════════════════════╗
║                   DEVSET CLI                   ║
║          One Command. Complete Setup.          ║
╚════════════════════════════════════════════════╝

Scanning project...

✓ Node.js detected (language)
✓ TypeScript detected (language)
✓ React detected (framework)
✓ Vite detected (framework)
✓ Python detected (language)
✓ Django detected (framework)
✓ npm detected (package-manager)
✓ pip detected (package-manager)

PROJECT TYPE: FULLSTACK

FRONTEND (frontend)
  Framework: Vite
  Language: TypeScript
  Package Manager: npm

BACKEND (backend)
  Framework: Django
  Language: Python
  Package Manager: pip

ENVIRONMENT
  Example: .env.example
  Status: .env file missing (template available)

SETUP PLAN
  1. Verify Python runtime installation
  2. Verify Node.js runtime installation
  3. Create .env configuration
  4. Create Python virtual environment (.venv) for backend
  5. Install backend dependencies (pip)
  6. Install frontend dependencies (npm)
  7. Validate environment and dependency setup

? Proceed with setup and dependency installation? (Y/n)
```

* * *

## CLI命令

| 命令 | 描述 |
| --- | :-: |
| `devset` (或 `npx devset-cli`） | 扫描项目，生成计划，并在批准后执行自动设置 |
| `devset analyze [dir]` | 深入扫描和表格报告的语言，框架，和清单 |
| `devset setup [dir]` | 执行自动依赖项设置 |
| `devset doctor` | 检查Node、Python、包管理器和工具的运行状况和版本 |
| `devset run` | 使用统一的日志并发运行所有配置的开发服务 |
| `devset clean` | 安全移除生成的devset `.venv` 确认后的配置文件 |

### 全局选项

-   `--dry-run`：无需修改文件或安装软件包即可模拟分析和安装计划。
-   `--verbose`：显示实时子进程标准输出/标准错误和调试跟踪。
-   `-y, --yes`：跳过交互式确认提示，接受默认值。
-   `--json`：将命令输出格式为raw JSON(支持 `analyze` 和 `doctor`）.
-   `-V, --version`：显示已安装的CLI版本。
-   `-h, --help`：显示命令选项和文档。

* * *

## 体系结构概述

DevSet遵循严格的模块化分离：

```text
src/
├── cli/           # Commander CLI, options, banner, subcommands
├── scanner/       # Safe file system crawler and directory classifier
├── detectors/     # Scoring-based rules for languages, frameworks, package managers, databases, Docker, env
├── analyzers/     # Dependency, structure, and project analyzers
├── validators/    # Runtime, dependency, and environment verification
├── installers/    # NpmInstaller, PythonInstaller, JavaInstaller, DockerInstaller
├── core/          # PlanGenerator and ExecutionEngine
├── runner/        # ProcessManager and ServiceRunner
├── utils/         # Cross-platform process execution, logger, and filesystem
└── types/         # TypeScript interfaces and schemas
```

看到 [文档/ architecture.md](https://npmcn.com/package/devset/docs/architecture.md) 获取完整的体系结构规格。

* * *

## 支持生态系统

| 生态系统 | 检测到 | 自动设置 | 多种服务的跑步者 |
| --- | :-: | :-: | :-: |
| **node . js** （npm, yarn, pnpm, bun） | 是 | 是 | 是 |
| **Python** （pip, poetry, pipenv, uv） | 是 | 是 | 是 |
| **Java** （Maven / Gradle包装器） | 是 | 是 | 诊断 |
| **Docker & Docker Compose** | 是 | 可选 | 诊断 |
| **数据库** （PostgreSQL, MySQL, SQLite, MongoDB, Redis） | 是 | 诊断 | \- |
| **Rust / Go / PHP / Ruby /。NET /扑动** | 是 | Detection-only (v1.0) | \- |

看到 [文档/ supported-technologies.md](https://npmcn.com/package/devset/docs/supported-technologies.md) 查看完整的列表。

* * *

## 本地开发和测试

```bash
# Clone the repository
git clone https://github.com/your-username/devset-cli.git
cd devset-cli

# Install development dependencies
npm install

# Build the project using tsup
npm run build

# Run unit and integration tests (Vitest)
npm test

# Link globally for local testing
npm link

# Test CLI
devset --help
devset doctor
```

* * *

## 发布到NPM

DevSet命令行是为NPM发布预先配置的：

```bash
# 1. Login to NPM
npm login

# 2. Run verification (builds & runs tests automatically)
npm run prepublishOnly

# 3. Publish to NPM
npm publish --access public
```

* * *

## 安全

DevSet执行带有严格参数数组的命令(`execa(file, args[])`)，根据目录遍历验证路径，从不记录秘密或令牌，也从不自动删除文件。阅读我们的 [文档/ security.md](https://npmcn.com/package/devset/docs/security.md) 查看完整的详细信息。

* * *

## 许可证

麻省理工学院© [DevSet维护者](https://npmcn.com/package/devset/LICENSE)

## 常见问题

### devset 是什么？

通用的，基于规则的项目分析和自动化环境设置工具

### 如何安装 devset？

在项目目录运行 npm install devset，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 devset、devset-cli，可以用 npx devset 直接运行。

### devset 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### devset 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### devset 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### devset 可以商用吗？

devset 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### devset 还在维护吗？

最新版本 1\.0\.3 发布于 2026/11/03（今天）；至今共发布 5 个版本，其中过去 12 个月发布了 5 个；首次发布于 2026/11/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。