# @genesislcap/foundation-cli 中文文档

规范地址：https://npmcn.com/package/%40genesislcap/foundation-cli/

版本：15\.96\.1
npm 元数据更新时间：2026-11-16T09:11:36.587Z
中文译文更新时间：2026-11-16T09:12:32.365Z
软件包许可：SEE LICENSE IN license\.txt

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

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

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

- 包体积（解压后）：2.1 MB，297 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：29 个
- 首次发布：2023-02-28T11:37:23.384Z
- 最新版本发布：2026-11-16T09:11:36.379Z
- 近 30 天下载量：19222（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：2654（近 12 个月 1022 个）

## 中文简介

创世纪基金会

## 安装

```sh
npm install @genesislcap/foundation-cli
```

也可以使用：`pnpm add @genesislcap/foundation-cli`、`yarn add @genesislcap/foundation-cli`、`bun add @genesislcap/foundation-cli`

## README

# 创世纪基金会

这回波包含我们的 **基础 cli** 用于遵循最佳做法的快速码脚手架工具.

[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/) [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)

## 应用塔克

种子可以在 `.genx/tasks.json`。 。 。 .

一个任务包含一个或多个步骤,可以执行各种命令.

```json
{
  "tasks": {
    "hello": {
      "name": "hello",
      "description": "Sample task",
      "steps": [
        {
          "say": "hello"
        }
      ]
    }
  }
}
```

运行 `foundation-cli app` 查看可用任务 :

```sh
$ foundation-cli app

  $ foundation-cli app <task>

Apps: Apps are seed instances. Tasks are commands provided by a seed.

  $ foundation-cli app List all tasks
  $ foundation-cli app hello Sample task
```

运行 `foundation-cli app hello`数字 :

```sh
$ foundation-cli app hello
hello | hello
```

### 执行命令

您可以按以下步骤执行命令:

-   `"exec": "gradle assemble"` 运行程序或脚本
-   `"spawn": "taskname"` 执行另一项任务(见下文)
-   `"builtin": "hello"` 运行由 CLI 提供的内置任务。 现有任务在 [任务文件夹](https://npmcn.com/package/%40genesislcap/foundation-cli/src/tasks.ts)。 。 。 .
-   `"say": "text"` 打印输出

使用时 `exec` 检查您的命令在不同平台( Windows, Linux, OS X) 上工作.

### 目录

你可以提供 `cwd` 选项设置任务或虚拟任务步骤的工作目录.

```json
{
  "tasks": {
    "build": {
      "name": "build",
      "description": "Build project",
      "cwd": ".genx/generated",
      "steps": [
        {
          "exec": "gradle assemble"
        },
        {
          "exec": "npm run build"
        },
        {
          "say": "all done"
        }
      ]
    }
  }
}
```

### 环境变量

您可以为某项任务或单个步骤设定环境变量.

您可以添加 `requiredEnv` 矩阵到任务以指定它运行时必须设置的环境变量.

说明:在这个例子中,我们本可以简单地做到 `"exec": "git branch --show-current"` 相反,它只是说明环境的可变用途.

```json
{
  "tasks": {
    "env": {
      "name": "env",
      "description": "Print current branch",
      "env": {
        "BRANCH": "$(git branch --show-current)"
      },
      "steps": [
        {
          "exec": "node -e \"console.log(process.env.BRANCH)\""
        }
      ]
    }
  }
}
```

```sh
$ foundation-cli app env
env | node -e "console.log(process.env.BRANCH)"
master
```

### 条件

您可以定义一个条件来确定是否应该执行任务 。 如果它返回一个零退出代码,步骤会被执行,否则跳过.

```json
{
  "tasks": {
    "diff": {
      "name": "diff",
      "description": "Detect changes",
      "steps": [
        {
          "exec": "echo 'working tree contains changes'"
        }
      ],
      "condition": "git diff --exit-code"
    }
  }
}
```

注:我们本可以做到的 `git diff --exit-code > /dev/null` 关闭 Linux/ OS X 上的 Git 输出, 但Windows 上不支持.

假设我们在工作目录中有一些变化,这些变化还没有被添加到 Git 中:

```sh
$ foundation-cli app diff
diff | condition: git diff --exit-code
# ... git diff output
diff | condition exited with non-zero - skipping
```

运行 Git 后添加命令 :

```sh
$ foundation-cli app diff
diff | condition: git diff --exit-code
diff | echo 'working tree contains changes'
working tree contains changes
```

### 依赖性任务

您可以定义依赖性任务 :

```json
{
  "tasks": {
    "first": {
      "name": "first",
      "description": "First task",
      "steps": [
        {
          "say": "first"
        }
      ]
    },
    "second": {
      "name": "second",
      "description": "Second task",
      "steps": [
        {
          "spawn": "first"
        },
        {
          "say": "second"
        }
      ]
    }
  }
}
```

```sh
$ foundation-cli app second
second » first | first
second | second
```

## 安装

要在应用程序中启用此模块, 请遵循以下步骤 .

1.  添加 `@genesislcap/foundation-cli` 作为你 `package.json` 文档。 当您改变您的项目的依赖性时, 请确保您运行 `$ npm run bootstrap` 再次指挥。 您可以在 [软件包.json 基础](https://learn.genesis.global/secure/web/basics/package-json-basics/) 页 次.

```json
{
  ...
  "dependencies": {
    ...
    "@genesislcap/foundation-cli": "latest"
    ...
  },
  ...
}
```

## [API 文档](https://npmcn.com/package/%40genesislcap/foundation-cli/docs/api/index.md)

## 许可证

注:该项目提供前端依赖性,并使用下一节所列许可部件;因此,开发期间需要对这些部件发放许可证。 联系人 [创世纪全球](https://genesis.global/contact-us/) 更多细节.

### 许可组件

创世纪低码平台

## 常见问题

### @genesislcap/foundation-cli 是什么？

创世纪基金会

### 如何安装 @genesislcap/foundation-cli？

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

### @genesislcap/foundation-cli 支持 TypeScript 吗？

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

### @genesislcap/foundation-cli 支持 ESM 还是 CommonJS？

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

### @genesislcap/foundation-cli 需要什么版本的 Node\.js？

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

### @genesislcap/foundation-cli 可以商用吗？

@genesislcap/foundation-cli 使用 SEE LICENSE IN license\.txt 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @genesislcap/foundation-cli 的下载量有多少？

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

### @genesislcap/foundation-cli 还在维护吗？

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

