# tinybird-typescript-sdk-guidelines

Provides guidelines for modeling Tinybird datasources, queries, and pipes via @tinybirdco/sdk with strict type inference. Useful when migrating from legacy configurations.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 1000 installs · ★ 22
- Author: tinybirdco
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/tinybirdco/tinybird-agent-skills/tree/HEAD/skills/tinybird-typescript-sdk-guidelines/SKILL.md
- Updated: 2026-07-29
- HTML: https://affpapa.org/en/nevibecode/skills/tinybird-typescript-sdk-guidelines

## What it does

This skill supplies architectural rules for the `@tinybirdco/sdk` library. It helps agents build typed query clients, define materialized views, and declare copy or sink pipes. It also provides reference patterns for external connections such as Kafka, Amazon S3, and Google Cloud Storage.

The guidelines detail standard CLI workflows. You initialize projects with `npx tinybird init`, run local branch development using `tinybird dev`, compile with `tinybird build`, and ship changes via `tinybird deploy`. For continuous integration checks, it specifies `tinybird preview`.

The SDK runs exclusively in server environments. Exposing access tokens inside client-side web bundles creates an immediate security hazard.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/tinybird-typescript-sdk-guidelines/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/tinybird-typescript-sdk-guidelines/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/tinybird-typescript-sdk-guidelines/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/tinybird-typescript-sdk-guidelines/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install tinybirdco/tinybird-agent-skills tinybird-typescript-sdk-guidelines
```

2. **Manually: put the files in place**
- File: `.github/skills/tinybird-typescript-sdk-guidelines/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/tinybirdco/tinybird-agent-skills --path skills/tinybird-typescript-sdk-guidelines
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/tinybird-typescript-sdk-guidelines/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/tinybirdco/tinybird-agent-skills/tree/HEAD/skills/tinybird-typescript-sdk-guidelines/SKILL.md

## When to use it
- convert legacy `.datasource` and `.pipe` files to TypeScript
- set up typed data ingestion and query clients
- configure storage connectors for S3, GCS, or Kafka
- define materialized views and copy pipes in code

## Example prompts
- Convert our legacy `analytics.datasource` definition into a TypeScript schema
- Create a typed client to query the active users endpoint
- Configure a Kafka connection and sink pipe using `@tinybirdco/sdk`

## Similar
- [xlsx](https://affpapa.org/en/nevibecode/skills/xlsx.md) — skill · 187223 installs
- [google-agents-cli-observability](https://affpapa.org/en/nevibecode/skills/google-agents-cli-observability.md) — skill · 511300 installs
- [caveman-evidence-review](https://affpapa.org/en/nevibecode/skills/caveman-evidence-review.md) — skill · 104500 installs
- [migration](https://affpapa.org/en/nevibecode/skills/migration.md) — skill · 103900 installs
- [performance-optimization](https://affpapa.org/en/nevibecode/skills/performance-optimization.md) — skill · 65200 installs
- [supabase](https://affpapa.org/en/nevibecode/skills/supabase.md) — skill · 8 installs

From the same set: [tinybirdco/tinybird-agent-skills](https://affpapa.org/en/nevibecode/by/tinybirdco/tinybird-agent-skills.md) — 4 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md