Workspaces¶

What is a Workspace?¶

A Workspace is an area that contains a set of Tinybird resources, including Data Sources, Pipes, Nodes, API Endpoints, and Auth Tokens.

What should I use Workspaces for?¶

Workspaces allow you to separate different projects, use cases, and dev/staging/production environments for the things you work on in Tinybird.

You can choose exactly how you organise your Workspaces, but the two common ways are a Workspace per project, or per team.

Creating Workspaces¶

You can create multiple Workspaces and doing so is easy. When you create a Workspace, you can start building immediately; there is no waiting for infrastrucure and resources to build.

Creating Workspaces in the UI¶

In the top left corner of the Tinybird UI you'll see the name of your current Workspace.

To create a new Workspace, click on the name of the existing Workspace in the top left corner.

You'll see a drop down that lists all of your active Workspaces.

Click the + icon as shown below.

This will open a dialog window with a form to help you create a new Workspace. You can give the Workspace a name by typing into the Workspace name box (see Mark 1 below).

If you want to use a Starter Kit, select it from the Starter kit dropdown (see Mark 2 below). When you're happy, click Create Workspace (see Mark 3 below).

Creating Workspaces in the CLI¶

To create a new Workspace from the CLI, you can use the following command:

tb workspace create

You can use this command interactively or by providing the required inputs with flags.

To use it interactively, just run the command without any flags (e.g. tb workspace create).

You will see several prompts that you need to complete.

First, you'll be asked to supply your User Auth Token.

Paste the token into the prompt.

In order to create a new workspace we need your user token. Copy it from https://ui.tinybird.co/tokens and paste it here:

You can select whether you want to use a Starter Kit for your new Workspace. Using the blank option will give you an empty Workspace.

------------------------------------------------------------------------------------
| Idx | Id            | Description                                                |
------------------------------------------------------------------------------------
|   1 | blank         | Empty workspace                                            |
|   2 | web-analytics | Starting workspace ready to track visits and custom events |
------------------------------------------------------------------------------------

[0] to cancel

Use starter kit [1]: 1

Next, you'll be asked to supply a name for your Workspace.

Workspace name [new_workspace_9479]: internal_creating_new_workspaces_example

A successful creation will give you the following output:

** Workspace 'internal_creating_new_workspaces_example' has been created

If you are using the CLI in an automated system, you probably don't want to use the interactive command. You can instead provide these options as flags:

tb workspace create --user_token <your_token> --starter-kit 1 internal_creating_new_workspaces_example

Deleting Workspaces¶

Deleting a Workspace deletes all resources within the Workspace, including Data Sources, any ingested data, Pipes and published APIs.

Deleting Workspaces in the UI¶

To delete a Workspace in the UI, click on the Cog icon at the top of the left side navigation bar, next to the Workspace name (see Mark 1 below).

This will open a dialog window. Click the three dots next to the Workspace name (see Mark 1 below). In the context menu, click Delete (see Mark 2 below).

Finally, you will be asked to confirm that you want to delete the Workspace. If you are sure, click Delete to finish deleting the Workspace.

Deleting Workspaces in the CLI¶

To delete a Workspace in the CLI, you can use the following command:

tb workspace delete

You will need to provide the name of the Workspace and your User Auth Token token, for example:

tb workspace delete my_workspace --user_token <your User Auth Token>

Managing Workspace members¶

Workspace users are referred to as "members". Their access to resources in Tinybird is managed at the Workspace level. You can invite as many members to a Workspace as you want, and a member can belong to multiple Workspaces.

Member capabilities are controlled with roles. A user's role can be changed at any time.

There are three roles in Tinybird:

Roles and capabilities