@devbie/fewbie-cli (英语)
用于"几比"前端框架的命令行工具. Scafold Next.js项目
,管理在
fewbie.json,更新框架所属模板文件,并生成已键入的 API
从 OpenAPI 文档中请求代码.
生成的项目使用情况 Next.js 16 (App Router), React 19 和 Tailwind (英语) CSS v4 (英语),带有"阴影"风格的UI原始和已经接通的设计活符.
所需资源
- 节点.js
>= 20
安装
直接运行它 npx数字 :
npx @devbie/fewbie-cli create my-app
或在全球安装:
npm install -g @devbie/fewbie-cli
fewbie --help
快开始
# Scaffold a new project (writes an empty fewbie.json declaration)
npx @devbie/fewbie-cli create my-app
cd my-app
npm install
npm run dev
# Declare and install registry modules (dependencies installed automatically)
npx fewbie modules add api-client auth
npx fewbie modules add login-form
# Inspect project state
npx fewbie doctor
npx fewbie status
这个 fewbie.json 声明
项目根包含一个列出登记册模块的声明文件 该项目使:
{
"modules": ["api-client", "auth", "login-form"]
}
这是 单一真相来源 用于每个模块操作。 一个文件
仅存在于磁盘上(启动模板传送一些注册文件)
没有 数为已安装. create 写入空声明; 所有其他
命令读取或更新.
图标
fewbie create <project-name>
从 Newbie 基本模板创建新项目 .
| 选项 | 说明 |
|---|---|
--template-path <dir> | 使用本地模板目录而不是克隆寄存器 . |
--template-ref <ref> | Git ref of the sewbie-starger profile 可以从中复制模板. |
--no-git-init | 跳过 git init 在新项目中. |
fewbie modules
只需引用即可打印模块清单。 在 TTY 上打开交互
启用/残废拾取器; 非TTY(或 --json它只读.
| 选项 | 说明 |
|---|---|
--json | 将模块目录打印为JSON. |
fewbie modules add <names...>
npm 样式添加: 在 fewbie.json 并登陆他们的
文件(包含依赖性关闭,npm依赖性自动安装).
| 选项 | 说明 |
|---|---|
-y, --yes | 跳过确认提示 . |
-f, --force | 覆盖已经存在但属于未声明模块的文件(例如由模板运出). |
--skip-install | 不运行 npm install 缺少依赖关系. |
--with-login-form | 同时安装 login-form 块,例如:. fewbie modules add auth --with-login-form。 。 。 . |
fewbie modules apply
对项目进行调和 fewbie.json: 恢复缺失的文件, 陆地
依赖性关闭成员,安装 npm 依赖性 .
| 选项 | 说明 |
|---|---|
--check | CI门:在不写任何东西的情况下验证已声明的集,其文件和依赖性. |
-y, --yes | 跳过确认提示 . |
-f, --force | 覆盖已经存在但属于未声明模块的文件(例如由模板运出). |
--skip-install | 不运行 npm install 缺少依赖关系. |
fewbie modules remove <names...>
从声明中删除模块。 文件仅在保存期间被删除 与登记册副本的字节相同;报告当地修改的文件 留着 删除另一个已声明模块仍然需要的模块失败 .
| 选项 | 说明 |
|---|---|
-y, --yes | 跳过确认提示 . |
fewbie modules update [names...]
更新已安装的文件到注册源 。 默认写入; 缺少文件
报告为 apply 工作而不是默默地重现.
| 选项 | 说明 |
|---|---|
--check | CI门:对照登记册核查已安装的文件;不写字. |
-y, --yes | 跳过确认提示 . |
fewbie template update [paths...]
从启动模板更新框架自有模板文件 。 通过路径
前缀( 如 ). src/app限制范围;没有路径意味着每条
框架自有资产.
所有权遵循ADR-025:
- 框架自有 模板覆盖:
next.config.ts, (中文(简体) ),tsconfig.json, (中文(简体) ),postcss.config.mjs, (中文(简体) ),eslint.config.mjs, (中文(简体) ),components.json, (中文(简体) ),.prettierignore, (中文(简体) ),.env.example, (中文(简体) ),src/instrumentation.ts, (中文(简体) ),src/lib/utils.ts。 。 。 . - 混合 - 只有中间的块
/* fewbie:framework:start */财务报告和审定财务报表/* fewbie:framework:end */更新(src/app/globals.css; 主机内容 在标记之外保存。 缺失的标记对被报告, 永远不会 猜对了. - 主机拥有 - 分发一次
create,从未碰过:src/app/layout.tsx, (中文(简体) ),src/app/page.tsx, (中文(简体) ),src/components/**, (中文(简体) ),package.json, (中文(简体) ),README.md, (中文(简体) ),next-env.d.ts, (中文(简体) ),AGENTS.md, (中文(简体) ),CLAUDE.md。 。 。 .
| 选项 | 说明 |
|---|---|
--template-path <dir> | 使用本地模板目录而不是克隆寄存器 . |
--template-ref <ref> | Git ref of the numberbie- starter profile 以更新模板从. |
--check | CI门:当模板文件漂移时打印diff并退出非零. |
fewbie apits [input]
从 OpenAPI 文档( URL 或本地端) 生成输入的 API 请求代码
JSON/YAML文件). 在第一次运行 命令脚手架 apits.config.ts· ;
随后运行通过 @devbie/apits
发电机,安装在项目中作为dev依赖.
| 选项 | 说明 |
|---|---|
-n, --name <name> | 只生成此名称的配置源 . |
-w, --watch | 监视本地 OpenAPI 文档,并在更改时重生 . |
--skip-install | 不安装生成器 dev 依赖 . |
fewbie doctor
请检查archive-date=中的日期值 (帮助) fewbie.json, (中文(简体) ),
部分安装的模块,依赖和设计符. 失踪
fewbie.json 是一个错误.
| 选项 | 说明 |
|---|---|
--json | (原始内容存档于2018-10-21). Emit-机器可读JSON. |
fewbie status
将机器可读项目状态打印为JSON(总是JSON,无旗). 报告
declared, (中文(简体) ), installed, (中文(简体) ), missing 文档和警告,用于自动化.
书记官处项目
内置登记册遵循阴影项惯例
(单位:千美元)registry:lib, (中文(简体) ), registry:component, (中文(简体) ), registry:block:
| 项目 | 类型 | 说明 |
|---|---|---|
api-client | lib | Axios 实例有无记名托肯验证, httply Only rest-cookie 旋转, 单飞 401 重试和主动的快取符. |
app-shell | block | 可折叠侧边栏原始人外加最小的导航阵列驱动AppShell骨架. |
auth | lib | 登录/ 日志帮助器、 会话过期的重定向绑定和主动更新的在 api 客户端上建起的拖带 . |
chart | component | 树形变色器注册、反应适配器、结构化数据图表和共享色调板. |
data-table | component | 带有客户端排序和页码的通用数据表. |
login-form | block | 账户/ Password 登录卡; 通过认证用户端和荣誉提交 ?redirect=。 。 。 . |
page-header | component | 标准页头有标题,描述和右对齐动作槽. |
password-checklist | block | 带有可重复使用的活密码规则核对表 isStrongPassword 上游(模仿后端政策). |
query-client | lib | TanStack Query singleton外加提供商组件,为App路由器有线. |
settings-required-state | block | 缺少所需的配置时显示空状态, 并设置调用动作 . |
sse-stream | lib | 基于POST的SSE运输,并带有帧解码,保存处理和中止支持. |
theme | component | next-themes 主题 Provider 包和光/ 暗切换按钮 . |
frontend-monitor-sdk | component | 浏览器边监测(PV/AJAX/resource/errors) @devbie/frontend-monitor-sdk; 脚手架为根布局设置客户端组件. |
启动模板中的目标路径必须保留
与模板副本的字节相同—— fewbie create 复制整个模板
时 fewbie modules add 复制项目(和 fewbie modules apply 恢复
因此同一文件有两个
分解编辑后分叉的传送通道.
npm run check:template-drift -w @devbie/fewbie-cli 在CI和CI中声称
发表前. npm run check:template-deps -w @devbie/fewbie-cli
附加比较模板已锁定 @devbie/* 对 npm 的版本
latest (网络;仅发布清单).
全球备选方案
| 选项 | 说明 |
|---|---|
-C, --cwd <dir> | 项目根目录( 默认为当前工作目录) . |
--dry-run | 在不触碰工作树的情况下打印计划中的写作/删除. |
运行 fewbie 没有参数打印帮助并成功退出.
相关软件包
@devbie/heartbeat-sdk——基本模板报告应用活性通过instrumentation.ts何时HEARTBEAT_ENDPOINT财务报告和审定财务报表HEARTBEAT_TOKEN已配置.@devbie/frontend-monitor-sdk——浏览器-侧式监控 SDK 作为frontend-monitor-sdk登记册项目.