mcpField
T
tinybird-typescript-sdk-guidelines

tinybird-typescript-sdk-guidelines

github.com/tinybirdcoデータ・データベース221.0k 回インストール13 週間前に更新
リポジトリ

tinybird-typescript-sdk-guidelines について

`@tinybirdco/sdk` を使い、型推論を備えた Tinybird リソースを TypeScript で定義するための開発者向けガイドです。設定、型付きクライアント、データ操作、CLI の手順に加え、従来のリソースファイルからの移行も扱います。

主な機能

  1. 01TypeScript でのデータソースとパイプ定義
  2. 02型付き Tinybird クライアント
  3. 03型安全な取り込みとクエリ
  4. 04接続とビューの設定
  5. 05開発・ビルド・デプロイコマンド

活用シーン

  1. 01TypeScript の Tinybird プロジェクトの初期設定
  2. 02型付きデータソースとエンドポイントの作成
  3. 03従来のリソースファイルからの移行
  4. 04変更のデプロイとプレビュー

インストール

コマンドをコピーしてターミナルで実行します。

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

インストール後、Claude Code で/tinybird-typescript-sdk-guidelinesを入力して読み込まれたか確認します。

同梱ファイル

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

詳細

Tinybird TypeScript SDK ガイドライン

完全な型推論を使用して、TypeScript で Tinybird リソースを定義するための @tinybirdco/sdk パッケージの使用ガイドです。

適用するケース

  • @tinybirdco/sdk のインストールまたは設定
  • TypeScript でのデータソースやパイプの定義
  • 型付き Tinybird クライアントの作成
  • 型安全な取り込みやクエリの使用
  • TypeScript プロジェクトでの tinybird dev/build/deploy コマンドの実行
  • レガシーな .datasource/.pipe ファイルから TypeScript への移行
  • 接続(Kafka、S3、GCS)の定義
  • マテリアライズドビュー、コピーパイプ、またはシンクパイプの作成

ルールファイル

  • 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

クイックリファレンス

  • インストール:npm install @tinybirdco/sdk
  • 初期化:npx tinybird init
  • 開発モード:tinybird dev(設定済みの devMode を使用します。通常はブランチです)
  • ビルド:tinybird build(設定済みの開発ターゲットを対象にビルドします)
  • デプロイ:tinybird deploy(main/production にデプロイします)
  • CI でのプレビュー:tinybird preview
  • サーバーサイド専用です。ブラウザーでトークンを公開しないでください

コメント