# tinybird-typescript-sdk-guidelines

Guides use of the @tinybirdco/sdk TypeScript package to define Tinybird datasources and pipes with type-safe ingestion and queries.

Skill by Tinybird. Category: Data and backend.

## Install

Project (for this project only):

```sh
npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines
```

Works with: Claude Code, Codex CLI, Cursor, Antigravity, Copilot CLI, opencode.

Global (for every project on this machine):

```sh
npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines -g
```

Works with: Claude Code, Codex CLI, Cursor, Antigravity, Copilot CLI, opencode.

## Tags

- Runs on your computer: It runs as a program on your machine, with your access.

## Security audits

- Gen Agent Trust Hub: Pass
- Socket: Pass
- Snyk: Pass
- Runlayer: Pass
- ZeroLeaks: Pass

Installs: 983. Installs counted by skills.sh. [Open on skills.sh](https://www.skills.sh/tinybirdco/tinybird-agent-skills/tinybird-typescript-sdk-guidelines)

## Source

[Open the source](https://github.com/tinybirdco/tinybird-agent-skills/tree/HEAD/skills/tinybird-typescript-sdk-guidelines). Checked 2026-10-10. This summary may contain AI-generated text, so it can be wrong. Check the source before you rely on it.

## SKILL.md

````markdown
---
name: tinybird-typescript-sdk-guidelines
description: 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.
---

# 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
````

- Previous: [tinybird-cli-guidelines](https://syn4pse.dev/terminal/tinybird-cli-guidelines.md)
- Next: [stream-docs](https://syn4pse.dev/terminal/stream-docs.md)
- [Terminal](https://syn4pse.dev/terminal.md)
- [Suggest a change](mailto:terminal@syn4pse.dev?subject=Terminal%20suggestion)
