tinybird-typescript-sdk-guidelines

par tinybirdco

SDK TypeScript Tinybird pour définir des datasources, pipes et requêtes avec inférence de type complète. À utiliser avec @tinybirdco/sdk, TypeScript Tinybird…

npx skills add https://github.com/tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines
Télécharger ZIPGitHub
19

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
  • Defining connections (Kafka, S3, GCS)
  • Creating materialized views, copy pipes, or sink pipes

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
  • rules/connections.md
  • rules/materialized-views.md
  • rules/copy-sink-pipes.md
  • rules/tokens.md

Quick Reference

  • Install: npm install @tinybirdco/sdk
  • Initialize: npx tinybird init
  • Dev mode: tinybird dev (uses configured devMode, typically branch)
  • Build: tinybird build (builds against configured dev target)
  • Deploy: tinybird deploy (deploys to main/production)
  • Preview in CI: tinybird preview
  • Server-side only; never expose tokens in browsers

Plus de skills de tinybirdco

tinybird
tinybirdco
Règles de configuration Tinybird, motifs SQL et conseils d'optimisation pour les sources de données, les pipes, les endpoints et les vues matérialisées. Couvre 13 catégories de règles incluant la structure de projet, la conception des sources de données et des pipes, les schémas d'endpoint, les vues matérialisées, les pipes de copie, les connexions, les bonnes pratiques SQL et les motifs de déduplication. Met l'accent sur les fichiers locaux comme source de vérité, MergeTree comme moteur de table par défaut, et du SQL en lecture seule avec une gestion stricte des paramètres. Fournit des stratégies d'optimisation : filtre...
official
tinybird-cli-guidelines
tinybirdco
Commandes, workflows et opérations de l'interface en ligne de commande Tinybird. À utiliser lors de l'exécution de commandes tb, de la gestion du développement local, du déploiement ou du travail avec des opérations de données.
official
tinybird-python-sdk-guidelines
tinybirdco
SDK Python Tinybird pour définir des datasources, des pipes et des requêtes en Python. À utiliser avec tinybird-sdk, des projets Python Tinybird, ou pour l'ingestion de données et…
official