tinybird-typescript-sdk-guidelines について
`@tinybirdco/sdk` を使い、型推論を備えた Tinybird リソースを TypeScript で定義するための開発者向けガイドです。設定、型付きクライアント、データ操作、CLI の手順に加え、従来のリソースファイルからの移行も扱います。
主な機能
- 01TypeScript でのデータソースとパイプ定義
- 02型付き Tinybird クライアント
- 03型安全な取り込みとクエリ
- 04接続とビューの設定
- 05開発・ビルド・デプロイコマンド
活用シーン
- 01TypeScript の Tinybird プロジェクトの初期設定
- 02型付きデータソースとエンドポイントの作成
- 03従来のリソースファイルからの移行
- 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.mdconfiguration.mdconnections.mdcopy-sink-pipes.mddefining-datasources.mddefining-endpoints.mdgetting-started.mdlow-level-api.mdmaterialized-views.mdtokens.mdtyped-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.mdrules/configuration.mdrules/defining-datasources.mdrules/defining-endpoints.mdrules/typed-client.mdrules/low-level-api.mdrules/cli-commands.mdrules/connections.mdrules/materialized-views.mdrules/copy-sink-pipes.mdrules/tokens.md
クイックリファレンス
- インストール:
npm install @tinybirdco/sdk - 初期化:
npx tinybird init - 開発モード:
tinybird dev(設定済みのdevModeを使用します。通常はブランチです) - ビルド:
tinybird build(設定済みの開発ターゲットを対象にビルドします) - デプロイ:
tinybird deploy(main/production にデプロイします) - CI でのプレビュー:
tinybird preview - サーバーサイド専用です。ブラウザーでトークンを公開しないでください
コメント
Markdown 対応