tb local¶
Manages the local development environment.
The following subcommands are available:
| Subcommand | Description | Arguments |
|---|---|---|
| generate-tokens | Generates random default user and workspace tokens for use in dev, CI/CD and testing. | None |
start | Starts the local development environment. Run with token args to set default values for |
|
| restart | Restarts the local development environment. | None |
| stop | Stops the local development environment. | None |
| remove | Removes the local development environment. |
tb local start¶
Starts the local development environment.
| Option | Description |
|---|---|
| -d, --daemon | Runs Tinybird Local in the background. By default, the command stays attached and watches the logs of Tinybird Local while it is running (-w, --watch). |
| --use-aws-creds | Uses the AWS credentials from your environment and passes them to the Tinybird Local container. Required to run S3 connections locally. See Using AWS credentials. |
| --volumes-path TEXT | Path to the volumes directory. If not provided, the container data isn't persisted. |
| --skip-new-version | Skips pulling the latest Tinybird Local image and uses your current local image. |
| --user-token TEXT | User token for the Tinybird Local container. Defaults to the TB_LOCAL_USER_TOKEN environment variable. |
| --workspace-token TEXT | Workspace token for the Tinybird Local container. Defaults to the TB_LOCAL_WORKSPACE_TOKEN environment variable. |
Environment support¶
| Environment | Supported | Description |
|---|---|---|
--local | ✗ No | This command manages Tinybird Local itself. |
--cloud | ✗ No | This command manages Tinybird Local itself. |
--branch=BRANCH_NAME | ✗ No | This command manages Tinybird Local itself. |