# @archsense/orakul-starter 中文文档

规范地址：https://npmcn.com/package/%40archsense/orakul-starter/

版本：0\.3\.1
npm 元数据更新时间：2023-09-07T10:46:16.508Z
中文译文更新时间：2026-11-06T14:39:36.999Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：133 kB，28 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：11 个
- 首次发布：2023-02-27T08:14:42.860Z
- 最新版本发布：2023-09-07T10:46:16.215Z
- 近 30 天下载量：7482（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 0 个）

## 中文简介

想象一下你的建筑

## 安装

```sh
npm install @archsense/orakul-starter
```

也可以使用：`pnpm add @archsense/orakul-starter`、`yarn add @archsense/orakul-starter`、`bun add @archsense/orakul-starter`

## README

# 奥拉库尔

> 项目架构可视化工具

## 如何使用

### 为工程配置 npm 脚本

1.  安装依赖 `npm install --save-dev @archsense/orakul-starter`
    
2.  配置 npm 脚本
    

```json
{
  ...
  "scripts": {
    ...
    "orakul": "npx orakul nestjs -p <path-to-root-folder>",
    ...
  }, 
}
```

### 单曲配置文件

1.  创建配置文件 `scout.json` 具有下列属性:

```json
{  
  "id": "<project/domain-id>",
  "src": "<path-to-src-folder | microservices>",
  "include": [
    "<list-of-folders-in-src-to-include-optional>"
  ],
  "exclude": [
    "<list-of-folders-in-src-to-exclude-optional>"
  ]
}
```

2.  配置 npm 脚本

```json
{
  ...
  "scripts": {
    ...
    "orakul": "npx orakul nestjs -c <path-to-config-folder>",
    ...
  }, 
}
```

3.  转到 [http://localhost:4501 (英语)](http://localhost:4501/) 要看到视觉

## 为什么奥拉库尔

1.  只有CLI命令 - 不需要额外的代码
2.  支持雀巢Js微型服务
3.  不同水平的可视化:模块水平和低水平
4.  只看你感兴趣的东西

## 常见问题

### @archsense/orakul-starter 是什么？

想象一下你的建筑

### 如何安装 @archsense/orakul-starter？

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

### @archsense/orakul-starter 支持 TypeScript 吗？

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

### @archsense/orakul-starter 支持 ESM 还是 CommonJS？

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

### @archsense/orakul-starter 可以商用吗？

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

### @archsense/orakul-starter 的下载量有多少？

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

### @archsense/orakul-starter 还在维护吗？

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