CLI command reference¶

The following list shows all available commands in the Tinybird command-line interface, their options, and their arguments.

Global options¶

The following options are available for all commands.

Enter them before the command name. For example: tb --host https://api.tinybird.co workspace ls.

tb auth¶

Configures your Tinybird authentication.

tb build¶

Builds your project and checks that all the resources are valid.

Pass the --watch flag to watch for changes and rebuild the project automatically.

tb copy¶

Manages copy pipes. The following subcommands are available:

tb copy run¶

Runs a copy job.

tb create¶

Creates an empty data project with CI/CD configuration files and a git repository.

Pass the --prompt flag to generate a customized starter project based on your prompt.

tb datasource¶

Manages data sources. The following subcommands are available:

tb datasource delete¶

Deletes a data source. For example, tb datasource delete my_datasource --wait.

tb datasource ls¶

Lists data sources.

tb datasource truncate¶

Truncates a data source. For example, tb datasource truncate my_datasource.

tb deployment¶

Deploys your project to the Tinybird platform. Run using --prod to deploy to production.

The following subcommands are available:

tb deployment create¶

Validates and deploy the project in Tinybird. Run using --prod to deploy to production.

You can also tb deploy as an alias of tb deployment create.

tb diff¶

Diffs local datafiles to the corresponding remote files in the Workspace.

tb endpoint¶

Manage endpoints. The following subcommands are available:

tb endpoint data¶

Prints data returned by the endpoint.

tb endpoint ls¶

Lists all the endpoints.

tb endpoint stats¶

Prints stats of the last 7 days for an endpoint.

tb fmt¶

Formats a datafile. For example: tb fmt my_datasource.datasource.

The following options are available:

This command removes comments starting with # from the file, so use DESCRIPTION or a comment block instead:

%
{% comment this is a comment and fmt keeps it %}

SELECT
  {% comment this is another comment and fmt keeps it %}
  count() c
FROM stock_prices_1m

tb job¶

Manage jobs. The following subcommands are available:

tb local¶

Manages the local development environment. The following subcommands are available:

tb login¶

Authenticates with your Tinybird account.

The command opens a browser window so that you can authenticate with your Tinybird account.

tb materialization¶

Manage materialized views. The following subcommands are available:

tb materialization ls¶

Lists materialized views.

tb materialization populate¶

Populates a materialized view.

tb mock¶

Generates sample data in /fixtures and sends it to the Data Source.

The command accepts a Data Source name as an argument. For example: tb mock events

tb pull¶

Retrieves the latest version for project files from your workspace.

tb sql¶

Run SQL query over data sources and pipes.

tb test¶

Generates and runs tests. The following subcommands are available:

tb test create¶

Creates a test in YAML format from an API endpoint.

For example: tb test create api_events --prompt "test for the customer id 42 and the event type 'purchase'".

tb test run¶

Runs all the tests in the project tb test run or specific tests passed as arguments. For example: tb test tests/run api_events.yaml.

tb test update¶

Updates the test's expectations. For example: tb test update api_events.

tb upgrade¶

Upgrades the CLI to the latest version.

tb workspace¶

Manage your Workspaces. The following subcommands are available:

tb workspace create¶

Creates a new Workspace for your Tinybird user.

tb workspace delete¶

Deletes a Workspace where you are an admin.

tb workspace members add¶

Adds members to the current Workspace. Takes a list of members emails as an argument.

tb workspace members rm¶

Removes members from the current Workspace. Takes a list of members emails as an argument.

tb workspace members set-role¶

Sets the role for existing Workspace members.

tb workspace use¶

Switches to another workspace. Use tb workspace ls to list the workspaces you have access to.