tinybird-typescript-sdk-guidelines
Guidance for using the @tinybirdco/sdk package to define Tinybird resources in TypeScript with complete type inference.
Works with
Installation Guide
How to use tinybird-typescript-sdk-guidelines on Cursor
AI-first code editor with Composer
Prerequisites
Before installing skills in Cursor, ensure your development environment meets these requirements:
- ›Cursor installed and configured on your machine
- ›Node.js 16+ with npm — verify with
node --version - ›Active project directory where you want to add
tinybird-typescript-sdk-guidelines
Run the install command
Execute the skills CLI command in your project's root directory to begin installation:
Fetches tinybird-typescript-sdk-guidelines from tinybirdco/tinybird-agent-skills and configures it for Cursor.
Select Cursor when prompted
The CLI shows a list of agents. Use arrow keys and space to select Cursor:
Verify installation
Confirm successful installation by checking the skill directory location:
Restart Cursor to activate tinybird-typescript-sdk-guidelines. Access via /tinybird-typescript-sdk-guidelines in your agent's command palette.
Security Notice
We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.
Skills execute code in your environment. Always review source, verify the publisher, and test in isolation before production.
Documentation
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.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
Quick Reference
- Install:
npm install @tinybirdco/sdk - Initialize:
npx tinybird init - Dev mode:
tinybird dev(uses configureddevMode, 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
List & Monetize Your Skill
Submit your Claude Code skill and start earning
Use Cases
Task Automation & Efficiency
Automate repetitive workflows and reduce manual effort
Example
Generate reports, summarize documents, draft communications
Save 3-5 hours per week on routine tasks
Knowledge Enhancement
Learn new skills, understand complex topics, get expert guidance
Example
Explain concepts, provide examples, suggest learning resources
Accelerate learning and skill development by 2x
Quality Improvement
Enhance output quality through reviews, suggestions, and refinements
Example
Review drafts, suggest improvements, catch errors
Improve work quality by 30-40% with less effort