Install Tinybird
Tinybird Local consists of a CLI tool and a containerized version of Tinybird that you can install on your machine or deploy on a cloud provider.
For a quick start guide, see Deploy a new project in five minutes.
Prerequisites
To install and use Tinybird Local on your machine, you need to have the following prerequisites:
- A free Tinybird account
- A container runtime, like Docker or Orbstack
- Linux or macOS
Install Tinybird on your machine
To install Tinybird, run the following command:
curl https://tinybird.co | sh
This installs the Tinybird CLI and the Tinybird Local container.
Authenticate with Tinybird Cloud
The best way to deploy your Tinybird project is Tinybird Cloud, a managed platform available in several cloud providers and regions.
Current Tinybird regions
| Region | Provider | Provider region | API base URL |
|---|---|---|---|
| Europe (London) | GCP | europe-west2 | https://api.europe-west2.gcp.tinybird.co |
| Europe (Frankfurt) | GCP | europe-west3 | https://api.tinybird.co |
| US East (Virginia) | GCP | us-east4 | https://api.us-east.tinybird.co |
| North America (Toronto) | GCP | northamerica-northeast2 | https://api.northamerica-northeast2.gcp.tinybird.co |
| Europe (Frankfurt) | AWS | eu-central-1 | https://api.eu-central-1.aws.tinybird.co |
| Europe (Ireland) | AWS | eu-west-1 | https://api.eu-west-1.aws.tinybird.co |
| US East (Virginia) | AWS | us-east-1 | https://api.us-east.aws.tinybird.co |
| US West (Oregon) | AWS | us-west-2 | https://api.us-west-2.aws.tinybird.co |
| Asia Pacific (Hong Kong) | AWS | ap-east-1 | https://api.ap-east-1.aws.tinybird.co |
| Asia Pacific (Sydney, Australia) | AWS | ap-southeast-2 | https://api.ap-southeast-2.aws.tinybird.co |
To authenticate your local environment with Tinybird Cloud, run the following command:
tb login
This opens a browser window where you can sign in to Tinybird Cloud.
Install on a cloud provider
To install Tinybird on a cloud provider, see Self-managed cloud.
Next steps
- Follow the Deploy a new project in five minutes quick start guide.
- Familiarize yourself with the core concepts of Tinybird. See Concepts.
- Learn about datafiles and their format. See Datafiles.