@byline/cli (英语)

引导安装器 线性CMS 输入已有的 TanStack Start 应用程序.

使用量

cd <your-tanstack-start-app>
npx @byline/cli init

安装器是一个分步向导. 它为计划中的文件撰写打印出统一的diffs. 确认模式相等于写入; 安全自动相可直接应用, 除非 --dry-run 已经设定.

byline init                    Run the wizard, re-detecting current installation state.
byline init --only db-init     Re-run a single phase.
byline init --from wire        Resume from a specific phase.
byline init --apply            Skip the per-phase confirmation prompt (still prints diffs).
byline init --dry-run          Show every change but write nothing.
byline init --database mysql   Select MySQL without the database prompt.
byline init --apply -y         Apply detected safe scaffold upgrades noninteractively.
byline doctor                  Inspect the current app and report what's wired.

见 byline init --help 为全旗列表.

数据库选择

安装器提供PostgreSQL(默认)和MySQL 8.0.14或更后. 过 --database postgres 或者说 --database mysql 以非交互方式选择。 马里亚DB 不支持, 而 Docker 策略仍然被推迟; 使用运行 带有管理员证书的服务器.

选择控制每个特定数据库的文物:

示例安装也收到匹配 @byline/search-postgres 或者说 @byline/search-mysql 供养. 最小设备省略了搜索. 这个 未选择的数据库软件包和环境变量不添加.

生成的收藏类型

byline init 创建 byline/generated/collection-types.ts 并添加两个应用程序脚本:

pnpm byline:generate        # regenerate after changing collection or block schemas
pnpm byline:generate:check  # fail without writing when the artifact is missing or stale

应用程序脚本评价 byline/collections/index.ts不装入 server.config.ts。收集图案仍然是运行时间登记册,而生成的模块 是它的定型,独立的类型Script投影,用于打字客户端和前端代码. 保留 完成CI的检查.

更新旧的脚手架和软件包

安装者检查依赖范围并需要文件而不是信任 旧完成相相旗. 运行 byline init --apply -y 应用检测到的安全性 脚手架升级. 缺少文件和公认的犬科前身可以是 安装,而用户拥有的脚手架、路由、维特、涡轮和CI各不相同 配置没有受到明确的手动指令的影响.

用于 CLI 版本 x.y.z时,选定的数据库适配器被固定在 x.y.z 因此,它符合捆绑的计划基线。 其他登记册支持的 @byline/* 依赖关系必须在 >=x.y.z <(x+1).0.0-0; 计划进行缺失或不兼容的申报 ^x.y.z当地 workspace:*, (中文(简体) ), workspace:^,以及 workspace:~ 链接永远不会 替换。 他们的软件包版本必须在当地解决,满足相同的要求 兼容层, 否则安装用手动屏蔽 指导.

在单列波中,从应用程序目录中运行 CLI 。 App文件保留在该目录下, 当 pnpm 设置时, Turbo 配置、 CI 检查和包管理锁定文件操作使用 最近的工作空间根,其宣布的软件包模式包括应用程序。 被排除的应用程序 这些模式仍然是独立的,不能改变外部工作空间的配置. 当拥有工作空间的人通过工作空间文件宣布一个软件包管理器时, root packageManager,或锁文件,安装器要求管理器和拒绝冲突 --pm 在规划依赖性之前. 对于一个软件包.json 唯一没有管理器元数据的工作空间,非交互运行必须通过 --pm。 。 。 . 选择 pnpm 创建 pnpm-workspace.yaml 现有工作空间套件模式 所需经费 allowBuilds 一起输入; npm, Yarn, 和 Bun 继续使用 package.json 工作空间.

已接通的应用程序( 后手动配置)

如果你用手把Byline接入你的应用(收集), server.config.ts, env, 路由, 脚手架文件全部到位), 只需要提供数据库和种子, 使用 setup 改为 init数字 :

byline setup                       Provision DB, then seed super-admin and example docs.
byline setup --database mysql      Select MySQL when no choice is recorded.
byline setup --no-seed-admin       Provision DB and seed docs only.
byline setup --no-seed-docs        Provision DB and seed super-admin only.
byline setup --no-seed-admin --no-seed-docs
                                   Provision DB only.
byline setup --reset --i-mean-it   Destructive: drop and recreate the database.
byline setup --force               Re-run every phase even if recorded as complete.
byline setup --force --reset --i-mean-it
                                   Full re-run: drop and recreate the database, then re-seed.

setup 运行前飞行、解析并核实数据库选择、检查 ,然后运行 db-init 财务报告和审定财务报表 的种子阶段。 它不会触及工程文件 。 递减或 推迟数据库选择在下游工作前停止命令 。 给新的 TanStack 启动需要全脚手架的应用程序, 使用 byline init。 。 。 .

默认 setup 咨询 .byline-install.json 并跳过阶段 记录为完整. --force 绕过完成状态,但不会转 将新的基线升级或削弱使用的数据库检查.

普通路径只应用 CLI 的释放特性, 被挤压的基线 转到缺少或空的数据库。 它拒绝现有的Byline计划 突变前不相关的占用计划。 升级现有安装 下方为本地 SQL 编号 packages/db-postgres/sql 或者说 packages/db-mysql/sql 从目标放出标记; 不适用 CLI 那些升级的脚本.

使用 --force --reset --i-mean-it 只是为了有意重建 重置跳过 占用数据库检查, 放弃命名的数据库, 重新应用新数据库 ,并丢弃所有文档数据。 无 --i-mean-it,重设路径 请求确认.