Tinybird TypeScript SDK Guidelines

Guidance for using the @tinybirdco/sdk package to define Tinybird resources in TypeScript with complete type inference.

When to Apply

• •Installing or configuring @tinybirdco/sdk
• •Defining datasources or pipes in TypeScript
• •Creating typed Tinybird clients
• •Using type-safe ingestion or queries
• •Running tinybird dev/build/deploy commands for TypeScript projects
• •Migrating from legacy .datasource/.pipe files to TypeScript

Rule Files

• •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

Quick Reference

• •Install: npm install @tinybirdco/sdk
• •Initialize: npx tinybird init
• •Dev mode: tinybird dev (watches and syncs to branches, not main)
• •Deploy: tinybird deploy (deploys to main/production)
• •Server-side only; never expose tokens in browsers