@starcier/create-builder

中文文档
1.0.0发布于 2026/11/02MITES Module零依赖

为客户端创建Starcier原型构建器:使用Starcier API注册其租户,并使用starter设计系统编写存储库。运行 npm create @starcier/builder.

中文使用文档
文档目录5 节
  1. 使用
  2. 连接设置
  3. 它保证了什么
  4. 选项
  5. 许可证

@starcier / create-builder

在一个命令中为客户端创建Starcier原型构建器:它注册客户端的 租户使用Starcier API,然后编写一个带有starter设计系统的存储库,这是一个例子 原型,以及编码代理的创作工具。评论,导游和分享 从 @starcier/* 包,作为依赖项安装。

创建租户需要一个 Starcier员工账户. 任何人都可以单独创建文件 --offline.

使用

npm create @starcier/builder@next

然后,它要求输入客户机的名称、租户标识符(从名称中建议)和文件夹 通过浏览器登录并创建租户。将任何东西作为选项传递到前面, 后 --:

npm create @starcier/builder@next acme-builder -- --name "Acme" --slug acme

直到 1.0.0 释放,使用 @next 如上所述。

连接设置

这些在客户端之间不会改变,所以它们是不变的 建在 而且你从不打字。覆盖 一个只能指向其他地方,比如一个本地API,带有一个选项或一个环境变量:

变量选项什么
STARCIER_API_URL--api-urlAPI的来源
STARCIER_AUTH0_DOMAIN--auth0-domainAuth0租户的域
STARCIER_AUTH0_AUDIENCE--auth0-audienceAPI的受众
STARCIER_AUTH0_CLIENT_ID--auth0-client-id构建器的单页应用程序,写入构建器的 .env
STARCIER_AUTH0_CLI_CLIENT_ID--cli-client-id使用此命令登录的本机应用程序
STARCIER_TOKEN--tokenAPI访问令牌,用于代替登录

内置值指向生产。只有 STARCIER_API_URL 不同的环境- 开发和生产共享一个Auth0租户和一个应用程序——因此针对开发的构建器由 覆盖那个变量。

签署。 该命令打开浏览器并要求您确认代码。通过 --token 相反,使用从Starcier平台复制的访问令牌,无法打开任何浏览器。

它保证了什么

  • 没有什么half-created。 文件在旁边准备好,只有在 租户的存在。如果不能创建租户——不能创建员工、已获取鼻涕虫、API不可达——否 文件夹落下了。
  • 被拿走的子弹是不会改变的。 你被要求再要一个;如果没有终端 命令停止。
  • 租户是客户端的身份,而不是他们的域。 建筑商的地址稍后会确定, 一旦部署;生成的README解释了这些步骤。

选项

运行 npm create @starcier/builder@next -- --help 查看完整列表。

许可证

麻省理工学院

版本与发布记录

@starcier/create-builder 共发布 4 个版本,首次发布于 2026/10/27;过去 12 个月发布了 4 个版本。

版本发布日期距今
1.0.0latest2026/11/02今天
1.0.0-next.1next2026/10/277 天前
1.0.0-next.02026/10/277 天前
0.0.0-stage2026/10/277 天前

关于 @starcier/create-builder 的常见问题

@starcier/create-builder 是什么?

为客户端创建Starcier原型构建器:使用Starcier API注册其租户,并使用starter设计系统编写存储库。运行 npm create @starcier/builder.

如何安装 @starcier/create-builder?

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

@starcier/create-builder 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/starcier__create-builder 是否存在。

@starcier/create-builder 支持 ESM 还是 CommonJS?

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

@starcier/create-builder 需要什么版本的 Node.js?

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

@starcier/create-builder 可以商用吗?

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

@starcier/create-builder 还在维护吗?

最新版本 1.0.0 发布于 2026/11/02(今天);至今共发布 4 个版本,其中过去 12 个月发布了 4 个;首次发布于 2026/10/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。