tinybird info - Tinybird TypeScript SDK

Displays comprehensive information about your Tinybird project, workspace, authentication, and current branch. Useful for debugging and verifying configuration.

Syntax

tinybird info [options]

Basic Usage

tinybird info

Output Example

tinybird info

Terminal

Workspace:
  Name:       my-workspace
  ID:         f7e8d9c0-1234-5678-90ab-cdef12345678
  Email:      [email protected]
  Region:     Europe (api.tinybird.co)
  Dashboard:  https://ui.tinybird.co/my-workspace
  Token:      p.eyJ1IjogIjEyMzQ1Njc4... (valid)

Branch:
  Git:        feature/analytics
  Tinybird:   feature-analytics
  Status:     active
  Created:    2024-01-15 10:23
  Dashboard:  https://ui.tinybird.co/my-workspace/branch/feature-analytics

Project:
  Directory:  /Users/you/project
  Config:     tinybird.config.json
  Dev Mode:   branch
  Main:       no

Branches (3):
  • feature-analytics (current)
  • feature-user-events
  • fix-schema-bug

Options

`--json`

Output as JSON for scripting:

tinybird info --json

{
  "success": true,
  "cloud": {
    "workspaceName": "my-workspace",
    "workspaceId": "f7e8d9c0-1234-5678-90ab-cdef12345678",
    "userEmail": "[email protected]",
    "apiHost": "https://api.tinybird.co",
    "dashboardUrl": "https://ui.tinybird.co/my-workspace",
    "token": "p.eyJ1IjogIjEyMzQ1Njc4..."
  },
  "project": {
    "cwd": "/Users/you/project",
    "configPath": "tinybird.config.json",
    "devMode": "branch",
    "gitBranch": "feature/analytics",
    "tinybirdBranch": "feature-analytics",
    "isMainBranch": false
  },
  "branch": {
    "name": "feature-analytics",
    "id": "branch-id-456",
    "token": "p.branch_token...",
    "dashboardUrl": "https://ui.tinybird.co/my-workspace/branch/feature-analytics"
  },
  "branches": [
    {
      "name": "feature-analytics",
      "id": "branch-id-456",
      "createdAt": "2024-01-15T10:23:00Z"
    }
  ]
}

Information Sections

Workspace

Your Tinybird workspace details:

Workspace:
  Name:       my-workspace
  ID:         f7e8d9c0-1234-5678-90ab-cdef12345678
  Email:      [email protected]
  Region:     Europe (api.tinybird.co)
  Dashboard:  https://ui.tinybird.co/my-workspace
  Token:      p.eyJ1IjogIjEyMzQ1Njc4... (valid)

Name: Workspace name in Tinybird
ID: Unique workspace identifier
Email: Your Tinybird account email
Region: API region (Europe or US East)
Dashboard: Link to workspace dashboard
Token: Current auth token (truncated)

Local (Local Mode Only)

When using local Tinybird:

tinybird info  # with devMode: "local"

Local:
  Running:    yes
  Workspace:  feature-analytics
  ID:         local-workspace-id
  API:        http://localhost:7181
  Dashboard:  http://localhost:7181/feature-analytics

Running: Whether local container is active
Workspace: Local workspace name
API: Local API URL
Dashboard: Local dashboard URL

Branch (Branch Mode)

Current branch information:

Branch:
  Git:        feature/analytics
  Tinybird:   feature-analytics
  Status:     active
  Created:    2024-01-15 10:23
  Dashboard:  https://ui.tinybird.co/my-workspace/branch/feature-analytics

Git: Original git branch name
Tinybird: Sanitized branch name
Status: Branch state (active, not created)
Created: When branch was created
Dashboard: Branch-specific dashboard URL

Project

Local project configuration:

Project:
  Directory:  /Users/you/project
  Config:     tinybird.config.json
  Dev Mode:   branch
  Main:       no

Directory: Current working directory
Config: Configuration file path
Dev Mode: Development mode (branch or local)
Main: Whether on main/master branch

Branches List

All branches in workspace:

Branches (3):
  • feature-analytics (current)
  • feature-user-events  
  • fix-schema-bug

Use Cases

Verify Configuration

Check your setup before development:

tinybird info

Verify:

✓ Token is valid
✓ Workspace is correct
✓ Branch matches git
✓ Config file loaded

Debug Authentication

When commands fail with auth errors:

tinybird info

Error: Invalid token

Fix:

tinybird login

Check Branch Status

Verify which branch you’re working on:

tinybird info | grep Branch

Branch:
  Git:        feature/analytics
  Tinybird:   feature-analytics

Scripting

Extract specific values:

# Get workspace name
WORKSPACE=$(tinybird info --json | jq -r '.cloud.workspaceName')
echo "Workspace: $WORKSPACE"

# Get branch name
BRANCH=$(tinybird info --json | jq -r '.branch.name')
echo "Branch: $BRANCH"

# Check if on main
IS_MAIN=$(tinybird info --json | jq -r '.project.isMainBranch')
if [ "$IS_MAIN" = "true" ]; then
  echo "On main branch"
fi

Examples

Check Workspace

tinybird info

View all workspace and project details.

JSON for CI

tinybird info --json > tinybird-info.json

Save info for CI/CD pipeline.

Compare Environments

# Development
TINYBIRD_TOKEN=$DEV_TOKEN tinybird info --json > dev.json

# Production  
TINYBIRD_TOKEN=$PROD_TOKEN tinybird info --json > prod.json

# Compare
diff dev.json prod.json

Verify Local Mode

tinybird info

Local:
  Running:    yes
  Workspace:  main

Confirms local Tinybird is running.

Quick Branch Check

tinybird info | grep Tinybird:

  Tinybird:   feature-analytics

Show just the Tinybird branch name.

Environment Detection

Git Branch

Info detects current git branch:

git checkout feature/new-endpoint
tinybird info

Branch:
  Git:        feature/new-endpoint
  Tinybird:   feature-new-endpoint
  Status:     not created

Main Branch

git checkout main
tinybird info

Project:
  Main:       yes

Branch:
  (none - using main workspace)

Not a Git Repo

cd /tmp/test
tinybird info

Project:
  Git Branch: (not a git repository)
  Main:       yes

Dashboard URLs

Info provides clickable dashboard URLs:

Workspace Dashboard

Workspace:
  Dashboard:  https://ui.tinybird.co/my-workspace

Click to view:

Main workspace resources
All datasources and pipes
Workspace settings

Branch Dashboard

Branch:
  Dashboard:  https://ui.tinybird.co/my-workspace/branch/feature-analytics

Click to view:

Branch-specific resources
Isolated from main
Test queries in branch

Local Dashboard

Local:
  Dashboard:  http://localhost:7181/my-workspace

Click to view local Tinybird UI.

Troubleshooting

No Config Found

Error: No tinybird config found

Run in project directory:

cd /path/to/project
tinybird info

Or initialize:

npx tinybird init

Invalid Token

Error: Invalid token or insufficient permissions

tinybird login
tinybird info

Workspace Not Found

Error: Failed to get workspace info

Check:

Token is valid
Workspace exists
Network connection

Local Not Running

Local:
  Running:    no

Start local Tinybird:

docker run -d -p 7181:7181 tinybirdco/tinybird-local:latest
tinybird info

login: Authenticate and get workspace info
branch: Manage branches shown in info
dev: Development based on info config
deploy: Deploy based on workspace info

Use info --json in scripts for reliable parsing. The human-readable format may change between versions.

Get Started

Core Concepts

Guides

CLI Commands

Configuration

​Syntax

​Basic Usage

​Output Example

​Options

​--json

​Information Sections

​Workspace

​Local (Local Mode Only)

​Branch (Branch Mode)

​Project

​Branches List

​Use Cases

​Verify Configuration

​Debug Authentication

​Check Branch Status

​Scripting

​Examples

​Check Workspace

​JSON for CI

​Compare Environments

​Verify Local Mode

​Quick Branch Check

​Environment Detection

​Git Branch

​Main Branch

​Not a Git Repo

​Dashboard URLs

​Workspace Dashboard

​Branch Dashboard

​Local Dashboard

​Troubleshooting

​No Config Found

​Invalid Token

​Workspace Not Found

​Local Not Running

​Related Commands

Build docs developers (and LLMs) love

Syntax

Basic Usage

Output Example

Options

`--json`

Information Sections

Workspace

Local (Local Mode Only)

Branch (Branch Mode)

Project

Branches List

Use Cases

Verify Configuration

Debug Authentication

Check Branch Status

Scripting

Examples

Check Workspace

JSON for CI

Compare Environments

Verify Local Mode

Quick Branch Check

Environment Detection

Git Branch

Main Branch

Not a Git Repo

Dashboard URLs

Workspace Dashboard

Branch Dashboard

Local Dashboard

Troubleshooting

No Config Found

Invalid Token

Workspace Not Found

Local Not Running

Related Commands