Directives du SDK TypeScript Tinybird

Orientations pour utiliser le package @tinybirdco/sdk afin de définir des ressources Tinybird en TypeScript avec inférence de type complète.

Quand appliquer

• Installation ou configuration de @tinybirdco/sdk
• Définition de datasources ou pipes en TypeScript
• Création de clients Tinybird typés
• Utilisation d'ingestion ou de requêtes type-safe
• Exécution de commandes tinybird dev/build/deploy pour des projets TypeScript
• Migration de fichiers .datasource/.pipe hérités vers TypeScript
• Définition de connexions (Kafka, S3, GCS)
• Création de vues matérialisées, copy pipes ou sink pipes

Fichiers de règles

• 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

Référence rapide

• Installer : npm install @tinybirdco/sdk
• Initialiser : npx tinybird init
• Mode dev : tinybird dev (utilise le devMode configuré, généralement une branche)
• Build : tinybird build (construit contre la cible dev configurée)
• Déployer : tinybird deploy (déploie vers main/production)
• Aperçu en CI : tinybird preview
• Côté serveur uniquement ; ne jamais exposer les tokens dans les navigateurs