Tinybird Local container¶
You can run your own Tinybird instance locally using the tinybird-local
container. This is useful for testing and development. For example, you can test Data Sources and Pipes in your data project before deploying them to production.
Tinybird Local doesn't include the following features:
- Tinybird UI
- Connectors
- Scheduled operations
- Batch operations
Prerequisites¶
To get started, you need a container runtime, like Docker or podman.
Run Tinybird Local¶
To run Tinybird locally, run the following command:
docker run --platform linux/amd64 -p 80:80 --name tinybird-local -d tinybirdco/tinybird-local:latest
By default, Tinybird Local runs on port 80, although you can expose it locally using any other port.
Local authentication¶
To authenticate with Tinybird Local, retrieve the Workspace admin token and pass it through the CLI:
TOKEN=$(curl -s http://localhost:80/tokens | jq -r ".workspace_admin_token") tb --host http://localhost:80 --token $TOKEN auth
After you've authenticated, you can get the default Workspace with the tb workspace ls
CLI command. For example:
tb workspace ls ** Workspaces: -------------------------------------------------------------------------------------------- | name | id | role | plan | current | -------------------------------------------------------------------------------------------- | Tinybird_Local_Testing | 7afc6330-3aae-4df5-8712-eaad216c5d7d | admin | Custom | True | --------------------------------------------------------------------------------------------
Next steps¶
- Learn about datafiles and their format. See Datafiles.
- Learn how advanced templates can help you. See Advanced templates.
- Browse the full CLI reference. See Command reference.