TypeScript SDK CLI commands

The TypeScript SDK ships with a tinybird CLI that you run via npx tinybird. It manages TypeScript-based Tinybird projects, syncs resources, and deploys them to Tinybird.

Install

npm install @tinybirdco/sdk

Commands

tinybird init

Scaffolds a new TypeScript project, authenticates you if needed, and can optionally add CI/CD workflow files.

npx tinybird init
npx tinybird init --force
npx tinybird init --skip-login

tinybird dev

Watch for changes and sync to Tinybird. Defaults to a feature branch; use --local to work against Tinybird Local.

npx tinybird dev
npx tinybird dev --local
npx tinybird dev --branch my_feature_branch

tinybird build

Build and push resources to a Tinybird branch. Use this in CI for preview environments.

npx tinybird build
npx tinybird build --dry-run
npx tinybird build --local

tinybird deploy

Deploy resources to your main Tinybird workspace (production).

npx tinybird deploy
npx tinybird deploy --dry-run

tinybird login

Authenticate with Tinybird and write credentials to .env.local.

npx tinybird login

Next steps

Updated