关于 tinybird-typescript-sdk-guidelines
面向使用 `@tinybirdco/sdk` 的开发者，介绍如何在 TypeScript 中定义带类型推断的 Tinybird 资源。内容涵盖配置、类型化客户端、数据操作和命令行流程，也包括从旧版资源文件迁移。
主要功能
- 01定义 TypeScript 数据源和管道
- 02创建类型化 Tinybird 客户端
- 03执行类型安全的摄取与查询
- 04配置连接和视图
- 05运行开发、构建与部署命令
适用场景
- 01初始化 TypeScript Tinybird 项目
- 02创建类型化数据源和端点
- 03迁移旧版资源文件
- 04部署并预览项目变更
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/tinybird-typescript-sdk-guidelines确认已加载。
包含的文件
除 SKILL.md 外，安装时一起下载的参考资料和脚本。
rules/cli-commands.mdconfiguration.mdconnections.mdcopy-sink-pipes.mddefining-datasources.mddefining-endpoints.mdgetting-started.mdlow-level-api.mdmaterialized-views.mdtokens.mdtyped-client.md详细介绍
Tinybird TypeScript SDK 指南
介绍如何使用 @tinybirdco/sdk 包，通过 TypeScript 定义 Tinybird 资源并获得完整的类型推断。
适用场景
- 安装或配置 @tinybirdco/sdk
- 使用 TypeScript 定义数据源或管道
- 创建类型化的 Tinybird 客户端
- 使用类型安全的写入或查询
- 为 TypeScript 项目运行 tinybird dev/build/deploy 命令
- 从旧版 .datasource/.pipe 文件迁移到 TypeScript
- 定义连接（Kafka、S3、GCS）
- 创建物化视图、复制管道或接收器管道
规则文件
rules/getting-started.mdrules/configuration.mdrules/defining-datasources.mdrules/defining-endpoints.mdrules/typed-client.mdrules/low-level-api.mdrules/cli-commands.mdrules/connections.mdrules/materialized-views.mdrules/copy-sink-pipes.mdrules/tokens.md
快速参考
- 安装：
npm install @tinybirdco/sdk - 初始化：
npx tinybird init - 开发模式：
tinybird dev（使用配置的devMode，通常为分支） - 构建：
tinybird build（针对配置的开发目标进行构建） - 部署：
tinybird deploy（部署到 main/production） - 在 CI 中预览：
tinybird preview - 仅限服务端使用；切勿在浏览器中暴露令牌
评论
支持 Markdown