# @archsense/scout 中文文档

规范地址：https://npmcn.com/package/%40archsense/scout/

版本：0\.2\.5
npm 元数据更新时间：2023-09-05T10:44:02.004Z
中文译文更新时间：2026-11-06T14:39:42.280Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40archsense/scout
原文对照：https://npmcn.com/package/%40archsense/scout/?lang=original
项目主页：https://github.com/ArchSense/archsense-mono#readme
源码仓库：https://github.com/ArchSense/archsense-mono

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

- 包体积（解压后）：37.8 kB，31 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2023-02-16T06:43:18.462Z
- 最新版本发布：2023-09-05T10:44:01.774Z
- 近 30 天下载量：7369（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 0 个）

## 中文简介

生成服务图

## 安装

```sh
npm install @archsense/scout
```

也可以使用：`pnpm add @archsense/scout`、`yarn add @archsense/scout`、`bun add @archsense/scout`

## README

# 童子军

> 生成服务图

## 安装

`npm install @archsense/scout`

## 如何使用

### 命令行

`npx scout nestjs -p <root-file-path> -c <config-file-path> -o <output-file-path>`

#### 参数

| 参数名称 | CLI 属性 | CLI 快捷键 | 强制性 | 说明 |
| --- | --- | --- | --- | --- |
| 根文件夹的路径 | 项目 | \- p | 对 | 根工程根文件夹的路径 。 如果 `config` 提供. |
| 配置文件夹的路径 | \--配置 | \- c , 说 | 没有 | 如果你想在单列波上进行侦察,通过配置而不是项目根 |
| 输出文件的路径 | \--产出 | \- 欧 | 没有 | 如果提供, 结果将存储在输出文件中 |

### API 密码

```js
const Scout = require('scout');

const nestjsScout = new Scout({
  rootPath: '<path-to-root-folder>',
  configPath: '<path-to-config-folder>',
  framework: 'nestjs',
});

const dependencyTree = await nestjsScout.analyze();
await nestjsScout.saveFile(outputFilePath, dependencyTree);
```

## 当前支助

-   支持的语言
    -   字体
-   支助框架
    -   网点Js

## 常见问题

### @archsense/scout 是什么？

生成服务图

### 如何安装 @archsense/scout？

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

### @archsense/scout 支持 TypeScript 吗？

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

### @archsense/scout 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @archsense/scout 可以商用吗？

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

### @archsense/scout 的下载量有多少？

根据 npm 官方下载统计，@archsense/scout 在 2026/10/07 – 2026/11/05 这 30 天内被下载 7,369 次，日均约 246 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @archsense/scout 还在维护吗？

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