@box-kite/create

中文文档
2.4.0发布于 2026/11/07MITES Module构建来源已验证近 30 天下载 2316

Start a Vite + React app with Box Kite and a design in it: npm create @box-kite@latest my-app -- --design mono

原始使用文档
文档目录4 节
  1. Options
  2. For your coding agent
  3. The designs
  4. Requirements

@box-kite/create

Start a Vite + React app with Box Kite and a design already in it.

npm create @box-kite@latest my-app -- --design mono
cd my-app
npm run dev

It runs Vite's own create-vite, then:

  • adds @box-kite/react and the design's fonts to package.json, and installs them;
  • writes the design to src/design.tsx: the palette, the page's colours and fonts, and every component's styles, in light and dark;
  • wraps the app in it in src/main.tsx;
  • replaces src/App.tsx with a sample page of buttons, fields, a dialog, tabs and a data grid;
  • removes the template's own App.css and logos;
  • writes AGENTS.md, CLAUDE.md and the MCP server's config for Claude Code, Cursor and VS Code, so a coding agent writes Box Kite right from its first prompt.

src/design.tsx and src/App.tsx are ordinary files in your project, so change them as you like.

Options

OptionWhat it does
-d, --design NAMEclassic, ember, azure or mono. Asks when it is not given.
-t, --template NAMEreact-ts (default), react-compiler-ts, react or react-compiler.
--no-installWrites the files and skips the install.
--overwriteEmpties the directory first when it has files in it.
--eslintUses ESLint instead of Oxlint, passed to create-vite.
--no-agentsLeaves out AGENTS.md, CLAUDE.md and the MCP server configs.
--agents-onlyAdds only those to an existing project, and creates no app.
--interactive / --no-interactiveAlways ask, or never ask. By default it asks when run in a terminal.

With npm, options go after --. pnpm and yarn take them directly:

pnpm create @box-kite my-app --design azure

For your coding agent

Box Kite is newer than any model's training data, and its prop names collide with other libraries' while the numbers mean different things. So a new app comes with:

  • AGENTS.md: the four facts a model gets wrong from memory, and a pointer to node_modules/@box-kite/react/AGENTS.md, the whole rules, which an upgrade keeps current. Codex, Cursor, Copilot, Windsurf, Cline and Zed read it on every run.
  • CLAUDE.md: the one line @AGENTS.md, which is how Claude Code reads the same file.
  • The MCP server (npx -y @box-kite/mcp) in .mcp.json, .cursor/mcp.json and .vscode/mcp.json. It runs the real styling engine, so an agent can check that a value works rather than guess. Each tool asks once before it starts a server from a project file.

For a project that already exists, run this in its root:

npm create @box-kite@latest -- --agents-only

It adds the block to your own AGENTS.md (and replaces it in place on a later run), the import to your CLAUDE.md, and the server beside the ones your MCP configs already list. It writes an editor's config only when that editor's folder is there, and leaves alone a config with comments in it, printing the entry to add by hand.

The designs

  • Classic: the components as Box Kite ships them, indigo on gray in the system font.
  • Ember: warm paper, a vermilion accent and a serif (Fraunces) for headings.
  • Azure: clear-sky blue on cool slate, frosted-glass layers and pill controls, with Sora for headings.
  • Mono: ink #16191e on white in Roboto, with 1px edges and focus drawn as a second pixel.

You can see each of them on box-kite.dev with the Theme button in the header.

Requirements

Node 22.12 or later, which is create-vite's own floor.

版本与发布记录

@box-kite/create 共发布 15 个版本,首次发布于 2026/10/20;过去 12 个月发布了 15 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.4.0latest2026/11/071 天前
2.3.12026/11/061 天前
2.3.02026/11/044 天前
2.2.182026/11/044 天前
2.2.172026/11/034 天前
2.2.162026/11/035 天前

关于 @box-kite/create 的常见问题

@box-kite/create 是什么?

Start a Vite + React app with Box Kite and a design in it: npm create @box-kite@latest my-app -- --design mono

如何安装 @box-kite/create?

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

@box-kite/create 支持 TypeScript 吗?

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

@box-kite/create 支持 ESM 还是 CommonJS?

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

@box-kite/create 需要什么版本的 Node.js?

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

@box-kite/create 可以商用吗?

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

@box-kite/create 的下载量有多少?

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

@box-kite/create 还在维护吗?

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