用途
Tinybird TypeScript SDK Guidelines 是一份围绕 @tinybirdco/sdk 的使用指南，用于在 TypeScript 中定义 Tinybird 资源并获得完整的类型推断。它适合在涉及 @tinybirdco/sdk、TypeScript 版 Tinybird 项目，以及需要类型安全的数据源、管道与查询等场景中参考。
适用时机
据资料，以下情况适合应用本指南：
- 安装或配置 @tinybirdco/sdk
- 用 TypeScript 定义 datasources 或 pipes
- 创建类型化的 Tinybird 客户端
- 使用类型安全的写入或查询
- 为 TypeScript 项目运行 tinybird dev/build/deploy 命令
- 从传统 .datasource/.pipe 文件迁移到 TypeScript
- 定义连接（Kafka、S3、GCS）
- 创建物化视图、copy pipes 或 sink pipes
规则文件
指南由以下规则文件组成：
- rules/getting-started.md
- rules/configuration.md
- rules/defining-datasources.md
- rules/defining-endpoints.md
- rules/typed-client.md
- rules/low-level-api.md
- rules/cli-commands.md
- rules/connections.md
- rules/materialized-views.md
- rules/copy-sink-pipes.md
- rules/tokens.md
快速参考
- 安装：npm install @tinybirdco/sdk
- 初始化：npx tinybird init
- 开发模式：tinybird dev（使用已配置的 devMode，通常是 branch）
- 构建：tinybird build（针对已配置的 dev 目标构建）
- 部署：tinybird deploy（部署到 main/production）
- CI 中预览：tinybird preview
使用方式与限制
SDK 仅用于服务端；切勿在浏览器中暴露令牌。除上述命令与规则文件说明外，资料未提供更多配置细节、平台要求、收费或价格信息。