# @aws-blocks/create-blocks-app 中文文档

规范地址：https://npmcn.com/package/%40aws-blocks/create-blocks-app/

版本：0\.4\.0
npm 元数据更新时间：2026-11-02T10:25:01.869Z
中文译文更新时间：2026-11-07T14:13:28.294Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aws-blocks/create-blocks-app
原文对照：https://npmcn.com/package/%40aws-blocks/create-blocks-app/?lang=original
项目主页：https://github.com/aws-devtools-labs/aws-blocks/tree/main/packages/create-blocks-app#readme
源码仓库：https://github.com/aws-devtools-labs/aws-blocks

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：518 kB，247 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2026-06-15T23:39:49.600Z
- 最新版本发布：2026-11-02T10:25:01.543Z
- 近 30 天下载量：25886（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 21 个）

## 中文简介

用于脚手架的 CLI 工具 AWS Blocks 项目.

## 安装

```sh
npm install @aws-blocks/create-blocks-app
```

也可以使用：`pnpm add @aws-blocks/create-blocks-app`、`yarn add @aws-blocks/create-blocks-app`、`bun add @aws-blocks/create-blocks-app`

## README

# 创建块应用程序

用于脚手架的 CLI 工具 AWS Blocks 项目.

## 概览

`create-blocks-app` 在现有应用程序中添加块或从模板中创建新项目. 它建立了 `aws-blocks/` 工作空间,配置 CDK 基础设施,并提供启动代码.

## 使用量

### 创建新工程

```bash
npx @aws-blocks/create-blocks-app my-app
```

只包含良性元数据的目标目录(VCS/editor/OS文件)或 `INSTRUCTIONS.md` 仍然被视为一个新项目; 任何其他先前存在的文件块脚手架,所以没有任何东西被覆盖.

### 从模板开始

```bash
npx @aws-blocks/create-blocks-app my-app --template react
```

模板和一行描述的完整列表,运行:

```bash
npx @aws-blocks/create-blocks-app --help
```

模板描述来自每个模板的 `package.json` (单位:千美元)`blocksTemplateDescription`因此CLI总是真理的来源.

### 添加到现有项目

```bash
npx @aws-blocks/create-blocks-app .
```

### 在扩展 Gen 2 工程中添加块

已经有一个扩展的Gen 2应用程序? 从您的工程根中运行 :

```bash
npx @aws-blocks/create-blocks-app .
```

CLI 检测您的扩展工程(`amplify/backend.ts`)并与之并列的块块——增加: `aws-blocks/` 工作空间,通过无记名符号布线认证,以及用于部署的脚手架npm脚本。 您已有的扩展认证、 数据和主机保存不动 .

## 创建什么

```
./
├── aws-blocks/
│   ├── index.ts          # Backend entry point
│   ├── index.cdk.ts      # CDK stack definition
│   ├── index.handler.ts  # Lambda handler
│   ├── client.js         # Auto-generated frontend client
│   ├── package.json      # Backend workspace dependencies
│   └── scripts/
│       ├── server.ts     # Local dev server
│       ├── sandbox.ts    # Sandbox deployment
│       ├── deploy.ts     # Production deployment
│       └── destroy.ts    # Stack teardown
├── cdk.json              # CDK configuration
├── src/
│   └── ...               # Your existing code
└── package.json          # Updated with Blocks scripts
```

### 后端结构

**aws-块/index.ts**

```typescript
import { ApiNamespace, Scope, AuthBasic, DistributedTable, Realtime } from '@aws-blocks/blocks';
import { z } from 'zod';

const scope = new Scope('my-app');

const auth = new AuthBasic(scope, 'auth', {
  passwordPolicy: { minLength: 8 },
});
export const authApi = auth.createApi();

const todoSchema = z.object({
  userId: z.string(),
  todoId: z.string(),
  title: z.string(),
  completed: z.boolean(),
});

const todos = new DistributedTable(scope, 'todos', {
  schema: todoSchema,
  key: { partitionKey: 'userId', sortKey: 'todoId' },
});

export const api = new ApiNamespace(scope, 'api', (context) => ({
  async createTodo(title: string) { /* ... */ },
  async listTodos() { /* ... */ },
  async toggleTodo(todoId: string) { /* ... */ },
  async deleteTodo(todoId: string) { /* ... */ },
}));
```

**aws-块/index.cdk.ts**

```typescript
import * as cdk from 'aws-cdk-lib';
import { BlocksStack } from '@aws-blocks/blocks/cdk';
import { fileURLToPath } from 'node:url';
import { dirname, join } from 'node:path';

const __dirname = dirname(fileURLToPath(import.meta.url));
const stackName = 'my-blocks-stack-prod';

const app = new cdk.App();
export const blocksStack = await BlocksStack.create(app, stackName, {
  backendHandlerPath: join(__dirname, 'index.handler.ts'),
  backendCDKPath: join(__dirname, 'index.ts'),
});
```

### 软件包.json 脚本

```json
{
  "scripts": {
    "dev": "tsx watch aws-blocks/scripts/server.ts",
    "sandbox": "tsx aws-blocks/scripts/sandbox.ts",
    "sandbox:deploy": "tsx aws-blocks/scripts/sandbox.ts --deploy-only",
    "sandbox:destroy": "tsx -C cdk aws-blocks/scripts/sandbox-destroy.ts",
    "deploy": "tsx aws-blocks/scripts/deploy.ts",
    "destroy": "tsx aws-blocks/scripts/destroy.ts",
    "build": "tsc && vite build"
  }
}
```

## 模板

可用的模板 : `default`, (中文(简体) ), `bare`, (中文(简体) ), `react`, (中文(简体) ), `backend`, (中文(简体) ), `nextjs`, (中文(简体) ), `auth-cognito`, (中文(简体) ), `amplify`, (中文(简体) ), `demo`。 。 。 .

下方的文件夹 `templates/` 是一个自我注册的模板。 每个 `package.json` 在该文件夹中设置一个 `blocksTemplateDescription` 字段,用于构建 `--help` 目录. 要查看当前模板列表及其一行描述:

```bash
npx @aws-blocks/create-blocks-app --help
```

## 相关软件包

-   [块](https://npmcn.com/package/%40aws-blocks/blocks/README.md) - 核心运行时间和建筑区块

## 许可证

阿帕奇 - 2.0

## 常见问题

### @aws-blocks/create-blocks-app 是什么？

用于脚手架的 CLI 工具 AWS Blocks 项目\.

### 如何安装 @aws-blocks/create-blocks-app？

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

### @aws-blocks/create-blocks-app 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/aws-blocks\_\_create-blocks-app 是否存在。

### @aws-blocks/create-blocks-app 支持 ESM 还是 CommonJS？

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

### @aws-blocks/create-blocks-app 可以商用吗？

@aws-blocks/create-blocks-app 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aws-blocks/create-blocks-app 的下载量有多少？

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

### @aws-blocks/create-blocks-app 还在维护吗？

最新版本 0\.4\.0 发布于 2026/11/02（5 天前）；至今共发布 21 个版本，其中过去 12 个月发布了 21 个；首次发布于 2026/06/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。