@genesislcap/foundation-cli

中文文档
15.96.1发布于 2026/11/16SEE LICENSE IN license.txtTypeScriptCommonJS近 30 天下载 1.9万

Genesis Foundation CLI

原始使用文档
文档目录10 节
  1. App Taks
  2. Executing commands
  3. Directories
  4. Environment variables
  5. Conditions
  6. Dependent tasks
  7. Installation
  8. API Docs
  9. License
  10. Licensed components

Genesis Foundation UI CLI

This repo contains our foundation-cli tool for rapid code scaffolding that adheres to best practices.

lerna TypeScript

App Taks

Seeds can optionally define tasks in .genx/tasks.json.

A task contains one or more steps, which can execute various commands.

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

Run foundation-cli app to see available tasks:

$ 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

Run foundation-cli app hello:

$ foundation-cli app hello
hello | hello

Executing commands

You can execute commands in a step as follows:

  • "exec": "gradle assemble" runs a program or a script
  • "spawn": "taskname" runs another task (see below)
  • "builtin": "hello" runs a builtin task provided by CLI. Available tasks are in tasks folder.
  • "say": "text" prints output

When using exec check that your command works on different platforms (Windows, Linux, OS X).

Directories

You can provide cwd option to set the working directory for a task or for an invidual task step.

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

Environment variables

You can set environment variables for a task or for an individual step.

You can add requiredEnv array to a task to specify environment variables which must be set for it to run.

Note: in this example we could have simply done "exec": "git branch --show-current" instead - it just illustrates environment variable use.

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

Conditions

You can define a condition to determine whether a task should be executed. If it returns a zero exit code, steps will be executed, otherwise skipped.

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

Note: we could have done git diff --exit-code > /dev/null to turn off Git output on Linux/OS X, but that's not supported on Windows.

Assuming we have some changes in the working directory, which haven't beedn added to Git yet:

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

After running Git add command:

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

Dependent tasks

You can define dependent tasks:

{
  "tasks": {
    "first": {
      "name": "first",
      "description": "First task",
      "steps": [
        {
          "say": "first"
        }
      ]
    },
    "second": {
      "name": "second",
      "description": "Second task",
      "steps": [
        {
          "spawn": "first"
        },
        {
          "say": "second"
        }
      ]
    }
  }
}
$ foundation-cli app second
second » first | first
second | second

Installation

To enable this module in your application, follow the steps below.

  1. Add @genesislcap/foundation-cli as a dependency in your package.json file. Whenever you change the dependencies of your project, ensure you run the $ npm run bootstrap command again. You can find more information in the package.json basics page.
{
  ...
  "dependencies": {
    ...
    "@genesislcap/foundation-cli": "latest"
    ...
  },
  ...
}

API Docs

License

Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact Genesis Global for more details.

Licensed components

Genesis low-code platform

版本与发布记录

@genesislcap/foundation-cli 共发布 2,654 个版本,首次发布于 2023/02/28;过去 12 个月发布了 1022 个版本。

版本发布日期距今
15.96.1latest2026/11/16今天
15.96.0-GENC-1665.32026/11/142 天前
15.96.02026/11/142 天前
15.95.2-GENC-1665.22026/11/132 天前
15.95.22026/11/133 天前
15.95.1-TROWE-845.12026/11/133 天前

其他发布通道:pa-659 → 13.2.0-pa-659.2,cem-manifest → 14.11.2-cem-manifest.1,web-types → 14.12.1-web-types.1,layout-autoload → 14.12.1-layout-autoload.1,layout-autosave-fix-test → 14.29.0-layout-autosave-fix-test.1,bny → 14.49.0-bny.2。

关于 @genesislcap/foundation-cli 的常见问题

@genesislcap/foundation-cli 是什么?

Genesis 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 和提交记录判断。