tinybird-typescript-sdk-guidelines

Name: tinybird-typescript-sdk-guidelines
Author: tinybirdco

github.com/tinybirdcoData & databases221.0k installsUpdated 13w ago

About tinybird-typescript-sdk-guidelines

Guidance for developers using `@tinybirdco/sdk` to define Tinybird resources in TypeScript with inferred types. It covers setup, typed clients, data operations, and CLI workflows, including migration from legacy resource files.

Key features

01TypeScript datasource and pipe definitions
02Typed Tinybird clients
03Type-safe ingestion and queries
04Connection and view configuration
05Development, build, and deployment commands

Use cases

01Setting up a TypeScript Tinybird project
02Creating typed datasources and endpoints
03Migrating legacy resource files
04Deploying and previewing project changes

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines

After installing, type/tinybird-typescript-sdk-guidelinesin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

rules/

cli-commands.md

configuration.md

connections.md

copy-sink-pipes.md

defining-datasources.md

defining-endpoints.md

getting-started.md

low-level-api.md

materialized-views.md

tokens.md

typed-client.md

Details

From the project README

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

Comments

Markdown supported

Details

Author: tinybirdco
Repository: tinybirdco/tinybird-agent-skills
Category: Data & databases
Installs: 1,022
GitHub stars: 22

Report

More skills

All skills

hyperframes-core

github.com/heygen-com

930.6k

The HyperFrames composition contract — build one renderable project. Use for composition structure, the `data-*` timing attributes, `class="clip"`, tracks, sub-compositions, variables, framework-owned media playback, deterministic-render rules, and validation. Also covers Tailwind projects and the STORYBOARD.md / SCRIPT.md plan formats. Read before writing composition HTML.

lark-base

open.feishu.cn

823.2k

Operate on Feishu Base: create tables, fields, records, and views; handle statistics, formulas/lookups, forms, dashboards, app mode (BaseApp/AppMode pages and components), Workspace directories, workflows, role permissions, and the template center (Base template categories, lists, and search). Use when encountering Base/multidimensional tables/bitable, BaseApp/AppMode, or /base/ or /app/ links. Do not use lark-apps for BaseApp; route file import/export to lark-drive and authentication/authorization to lark-shared.

lark-sheets

open.feishu.cn

821.8k

Feishu Spreadsheets: create and operate spreadsheets. Supports worksheets and row/column structures (add/delete/merge/size/hide/freeze/group), cell read/write (values/formulas/styles/comments/cell images), range copy/move/sort/fill, find and replace, bulk updates, and creating and maintaining objects such as charts, pivot tables, conditional formatting, filters and filter views, dropdown lists, sparklines, and floating images. Also supports formula validation, restoring historical versions, and importing/exporting local Excel/CSV files and Feishu spreadsheets. Use when users need to create or edit spreadsheets, summarize and visualize data, format spreadsheets, calculate formulas (including migrating Excel formulas), or build financial models (DCF, three statements, budgets, Sensitivity, etc.). For multidimensional tables (Base/bitable), use lark-base. If users want to search for spreadsheet files in cloud storage (Drive/cloud storage) by name or keyword, use lark-drive's drive +search to locate resources first. When users provide a doubao.com /sheets/ URL/token, use this skill directly; do not fall back to WebFetch because the domain is not Feishu. Routing is based on the URL path pattern and token, not the domain.

remotion-best-practices

github.com/remotion-dev

701.4k

Best practices and domain knowledge for building videos programmatically with Remotion (videos in React/TypeScript, rendered to MP4). Use whenever writing or editing Remotion code — scaffolding a video project, animating with interpolate/spring over useCurrentFrame(), sequencing scenes and transitions, captions/subtitles, audio, GIFs/Lottie/3D, charts, visual effects, dynamic duration via calculateMetadata, or rendering. Consult before reaching for a Remotion API, since its components and props evolve (e.g. @remotion/media).