OpenParable
Skip to content
← Back to skills

Tinybird Typescript SDK Guidelines

Development
tinybird-typescript-sdk-guidelines

Tinybird Typescript SDK Guidelines is an Agent Skill for development published in the MapleTechLabs/maple repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Tinybird TypeScript SDK for defining datasources, pipes, and queries with full type inference. Use when working with @tinybirdco/sdk, TypeScript Tinybird projects, or type-safe data ingestion and queries.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/MapleTechLabs/maple/blob/HEAD/.agents/skills/tinybird-typescript-sdk-guidelines/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/tinybird-typescript-sdk-guidelines, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

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