### Install Tinybird SDK Locally

Source: https://www.tinybird.co/docs/forward/quickstarts/typescript-sdk

Add the Tinybird SDK to your project's dependencies using pnpm. This is recommended for consistency with quickstart examples.

```bash
pnpm add @tinybirdco/sdk

```

--------------------------------

### Start Docker Containers

Source: https://www.tinybird.co/docs/forward/get-data-in/connectors/kafka/index

Starts the necessary Docker containers for a local Kafka environment.

```bash
docker compose up
```

--------------------------------

### Bootstrap Servers Configuration Example

Source: https://www.tinybird.co/docs/forward/get-data-in/connectors/kafka

Example of configuring multiple bootstrap servers using a comma-separated list. Ensure you use the advertised listeners address.

```text
KAFKA_BOOTSTRAP_SERVERS broker1:9092,broker2:9092,broker3:9092
```

--------------------------------

### Install tinybird-sdk

Source: https://www.tinybird.co/docs/forward/dev-reference/commands/python-sdk-cli

Install the tinybird-sdk package using pip.

```bash
pip install tinybird-sdk

```

--------------------------------

### Install Tinybird SDK Globally

Source: https://www.tinybird.co/docs/forward/quickstarts/typescript-sdk

Install the Tinybird SDK globally using pnpm for direct access to the `tinybird` CLI.

```bash
pnpm add -g @tinybirdco/sdk

```

--------------------------------

### Initialize Go Module and Install ClickHouse Client

Source: https://www.tinybird.co/docs/forward/work-with-data/publish-data/guides/connect-clickhouse-go

Initialize your Go project and install the ClickHouse Go client. Ensure you are using Go 1.19 or later.

```bash
go mod init your-project
go get github.github.com/ClickHouse/clickhouse-go/v2

```

--------------------------------

### Example Data Query

Source: https://www.tinybird.co/docs/forward/work-with-data/publish-data/guides/advanced-dynamic-endpoints-functions

This query joins events data with product information to create a sample dataset for demonstration.

```sql
SELECT *, price, city, day FROM events_mat
ANY LEFT JOIN products_join_sku ON product_id = sku

```

--------------------------------

### Start Tinybird Local

Source: https://www.tinybird.co/docs/forward/development-workflow/local-development

Run this command to initialize and start all necessary Tinybird services locally. Ensure you see the 'Tinybird Local is ready!' message before proceeding.

```bash
tb local start
```

--------------------------------

### Example .datasource file

Source: https://www.tinybird.co/docs/forward/dev-reference/datafiles/datasource-files

A typical .datasource file demonstrating schema, engine, partitioning, sorting, TTL, and settings.

```datasource
# A comment
SCHEMA >
    `timestamp` DateTime `json:$.timestamp`,
    `session_id` String `json:$.session_id`,
    `action` LowCardinality(String) `json:$.action`,
    `version` LowCardinality(String) `json:$.version`,
    `payload` String `json:$.payload`

ENGINE "MergeTree"
ENGINE_PARTITION_KEY "toYYYYMM(timestamp)"
ENGINE_SORTING_KEY "timestamp"
ENGINE_TTL "timestamp + toIntervalDay(60)"
ENGINE_SETTINGS "index_granularity=8192"

```

--------------------------------

### Bootstrap Servers Configuration Example

Source: https://www.tinybird.co/docs/forward/get-data-in/connectors/kafka/index

Example of configuring multiple Kafka bootstrap servers using a comma-separated list. Ensure you use the advertised listener address.

```plaintext
KAFKA_BOOTSTRAP_SERVERS broker1:9092,broker2:9092,broker3:9092

```

--------------------------------

### Example .env file content

Source: https://www.tinybird.co/docs/forward/work-with-data/publish-data/guides/consume-apis-nextjs

This is an example of the .env file content, showing the required environment variables for connecting to Tinybird. Ensure these are correctly set for your workspace.

```env
TINYBIRD_SIGNING_TOKEN="YOUR SIGNING TOKEN"
TINYBIRD_WORKSPACE="YOUR WORKSPACE ID"
NEXT_PUBLIC_TINYBIRD_HOST="YOUR API HOST e.g. https://api.tinybird.co"

```

--------------------------------

### Copy .env.example to .env.local

Source: https://www.tinybird.co/docs/forward/work-with-data/publish-data/guides/consume-apis-nextjs

Create a local environment file by copying the example. This file will store your sensitive Tinybird credentials.

```bash
cp .env.example .env.local

```

--------------------------------

### Install TypeScript SDK Locally

Source: https://www.tinybird.co/docs/forward/dev-reference/commands/typescript-sdk-cli

Install the `tinybird` SDK as a project dependency using pnpm. You can then execute commands using `npx tinybird`.

```bash
pnpm install @tinybirdco/sdk
```

--------------------------------

### Install Tinybird CLI and Local Container

Source: https://www.tinybird.co/docs/forward/install-tinybird

Run this command on macOS and Linux to install the Tinybird CLI and the Tinybird Local container.

```bash
curl https://tinybird.co | sh

```

--------------------------------

### Start Tinybird Local with Docker Compose

Source: https://www.tinybird.co/docs/forward/install-tinybird/local

Command to start the Tinybird Local container using the defined Docker Compose configuration.

```bash
docker compose up -d

```

--------------------------------

### Start Development Session on a Branch

Source: https://www.tinybird.co/docs/forward/development-workflow/cloud-branches

Start a development session against a manually created branch using the `dev` command with the `--branch` flag.

```bash
tb --branch=preview_1 dev

```

--------------------------------

### Topic Versioning Example

Source: https://www.tinybird.co/docs/forward/get-data-in/connectors/kafka/guides/schema-management

Illustrates topic versioning strategy for handling breaking schema changes by creating separate topics for each version.

```text
orders-v1
orders-v2
orders-v3
```

--------------------------------

### Example with DEFAULT values

Source: https://www.tinybird.co/docs/forward/dev-reference/datafiles/datasource-files

Illustrates setting default values for columns like timestamp, status, count, and active status.

```datasource
SCHEMA >
    `timestamp` DateTime DEFAULT now(),
    `status` String DEFAULT 'pending',
    `count` Int32 DEFAULT 0,
    `is_active` UInt8 DEFAULT 1

```

--------------------------------

### Start Tinybird Local with Explicit Tokens

Source: https://www.tinybird.co/docs/forward/administration/tokens

Alternatively, you can pass the generated user and workspace tokens directly as arguments to the `tb local start` command. Ensure you copy the token values generated by `tb local generate-tokens`.

```bash
tb local generate-tokens
tb local start --user-token=<USER_TOKEN> --workspace-token=<WORKSPACE_TOKEN>

```

--------------------------------

### tb Help and Version

Source: https://www.tinybird.co/docs/forward/dev-reference/commands/tb

Display the help information for the 'tb' command or check its installed version.

```bash
tb --help
tb --version
```

--------------------------------

### Run the Next.js development server

Source: https://www.tinybird.co/docs/forward/work-with-data/publish-data/guides/consume-apis-nextjs

Start the local development server for your Next.js application. Access the running application via your web browser.

```bash
npm run dev

```

--------------------------------

### List Endpoints in Staging Deployment

Source: https://www.tinybird.co/docs/forward/development-workflow/manual-deployment

Run commands against a staging deployment using the `--staging` flag. This example lists endpoints.

```bash
tb --staging --cloud endpoint ls

```

--------------------------------

### Initialize Python Project and Add SDK

Source: https://www.tinybird.co/docs/forward/quickstarts/python-sdk

Create a new directory, initialize a Python SDK project, and add the necessary Tinybird and dotenv packages using uv.

```bash
mkdir tinybird-python-quickstart
cd tinybird-python-quickstart
git init

uv init --name tinybird-sdk-python-sample --python 3.13
uv add tinybird-sdk python-dotenv

uv run tinybird init --folder src/tinybird/

```

--------------------------------

### Start Docker Compose with AWS CLI Profile Export

Source: https://www.tinybird.co/docs/forward/get-data-in/connectors/s3

If using named AWS profiles, you can export credentials from a profile using the AWS CLI before starting your Docker Compose setup.

```bash
# Export credentials from a named profile
eval "$(aws configure export-credentials --profile my-profile --format env)"

# Start Docker Compose
docker compose up -d

```

--------------------------------

### Complete column definition example

Source: https://www.tinybird.co/docs/forward/dev-reference/datafiles/datasource-files

Shows a column definition with data type, JSON path, default value, and compression codec.

```datasource
SCHEMA >
    `timestamp` DateTime64(3) `json:$.timestamp` DEFAULT now() CODEC(DoubleDelta, ZSTD(1)),
    `session_id` String `json:$.session_id` DEFAULT '' CODEC(ZSTD(1)),
    `status` LowCardinality(String) `json:$.status` DEFAULT 'unknown',
    `count` Int32 `json:$.count` DEFAULT 0,
    `payload` String `json:$`

```

--------------------------------

### Create preview environment with tinybird preview

Source: https://www.tinybird.co/docs/forward/dev-reference/commands/python-sdk-cli

Create a preview environment and deploy project resources. Use --dry-run to simulate deployment, --check for validation, or --name to specify a name for the preview.

```bash
tinybird preview

```

```bash
tinybird preview --dry-run

```

```bash
tinybird preview --check

```

```bash
tinybird preview --name pr_482

```

--------------------------------

### Example Comment Block with tb fmt

Source: https://www.tinybird.co/docs/forward/dev-reference/commands/tb-fmt

Shows how `tb fmt` handles comments. Comments starting with '#' are removed, but comments within {% comment %} blocks are preserved.

```sql
% 
{% 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

```

--------------------------------

### GitLab CI/CD Deployment

Source: https://www.tinybird.co/docs/forward/get-data-in/connectors/kafka/guides/cicd-version-control

Configure GitLab CI to automate Tinybird deployments. This setup installs the Tinybird CLI and runs deployment commands within the CI pipeline.

```yaml
deploy:
  image: ubuntu:latest
  before_script:
    - apt update && apt install -y curl
    - curl https://tinybird.co | sh
    - export PATH="$HOME/.local/bin:$PATH"
  script:
    - tb --cloud --host $TINYBIRD_HOST --token $TINYBIRD_TOKEN connection data <connection_name>
    - tb --cloud --host $TINYBIRD_HOST --token $TINYBIRD_TOKEN deploy
  only:
    - main
```

--------------------------------

### Install Tinybird AI Python SDK

Source: https://www.tinybird.co/docs/forward/get-data-in/guides/ingest-litellm

Install the necessary Python SDK for integrating with Tinybird's AI features. This command installs the core SDK with AI support.

```bash
pip install tinybird-python-sdk[ai]
```

--------------------------------

### Initialize Tinybird Project

Source: https://www.tinybird.co/docs/forward/quickstarts/cli

Create a new directory, initialize it as a Git repository, and then initialize the Tinybird project.

```bash
mkdir tinybird-cli-quickstart
cd tinybird-cli-quickstart
git init

tb init

```

--------------------------------

### Set Up Local Development Cycle

Source: https://www.tinybird.co/docs/forward/tinybird-code/workflows

Configure local development by generating mock data, testing endpoints with various parameters, and displaying API URLs and example responses.

```text
Set up local development for my project:
- Generate realistic mock data for all landing tables
- Test all endpoints in local with different parameters
- Show me the API URLs and example responses
```

--------------------------------

### Start Docker Services

Source: https://www.tinybird.co/docs/forward/get-data-in/connectors/kafka/guides/local-development

Starts the services defined in the docker-compose.yml file in detached mode.

```bash
docker compose up -d
```

--------------------------------

### Start Kafka Ingestion

Source: https://www.tinybird.co/docs/forward/dev-reference/commands/tb-datasource

Starts Kafka ingestion for a Data Source, which is only available for Kafka-connected Data Sources in branches or Tinybird Local. This command creates a new consumer group and starts ingestion from the latest offset.

```bash
tb [--branch=BRANCH_NAME] datasource start my_kafka_datasource
```

--------------------------------

### Query Result Example

Source: https://www.tinybird.co/docs/forward/quickstarts/cli

This is an example of the JSON response you might receive when querying the 'top_pages' endpoint.

```json
{
  "meta": [
    { "name": "pathname", "type": "String" },
    { "name": "views", "type": "UInt64" }
  ],
  "data": [
    { "pathname": "/home", "views": 1 },
    { "pathname": "/docs", "views": 1 },
    { "pathname": "/pricing", "views": 1 }
  ]
}

```

--------------------------------

### Install Tinybird Agent Skills

Source: https://www.tinybird.co/docs/forward/analytics-agents/agent-skills

Use this command to install the open-source agent skills from the tinybirdco/tinybird-agent-skills repository.

```bash
npx skills add tinybirdco/tinybird-agent-skills

```

--------------------------------

### Initialize Tinybird Project with Options

Source: https://www.tinybird.co/docs/forward/dev-reference/commands/tb-init

Use options to specify project type, development mode, project folder, and CI/CD templates during initialization.

```bash
tb init --type cli --dev-mode manual --folder . --cicd github

```

--------------------------------

### Example Workspace Admin Token

Source: https://www.tinybird.co/docs/forward/administration/tokens/jwt

This is an example of a Tinybird workspace admin token, used as a signing key for generating JWTs.

```text
p.eyJ1IjogIjA1ZDhiYmI0LTdlYjctND...
```

--------------------------------

### Manage Kafka Ingestion in Branches

Source: https://www.tinybird.co/docs/forward/development-workflow/cloud-branches

Kafka ingestion is stopped by default in branches. Use `tb datasource start` to begin ingesting and `tb datasource stop` to pause. Each start creates a new consumer group with a unique ID, starting from the latest offset.

```bash
tb --branch=preview_1 datasource start my_kafka_datasource
# ... observe data flowing in, test your pipelines ...
tb --branch=preview_1 datasource stop my_kafka_datasource

```

--------------------------------

### Start Kafka ingestion using Tinybird CLI

Source: https://www.tinybird.co/docs/forward/get-data-in/connectors/kafka/index

Resume Kafka ingestion for a data source using the 'tb datasource start' command. In branches, this creates a new consumer group starting from the latest offset. In Tinybird Local, it resumes from the last committed offset.

```bash
tb [--branch=BRANCH_NAME] datasource start my_kafka_datasource

```

--------------------------------

### Install ClickHouse Python Client

Source: https://www.tinybird.co/docs/forward/work-with-data/publish-data/guides/connect-clickhouse-python

Install the official ClickHouse Python client using pip. Ensure you have Python 3.8 or later.

```bash
pip install clickhouse-connect

```

--------------------------------

### Install ClickHouse JavaScript Client

Source: https://www.tinybird.co/docs/forward/work-with-data/publish-data/guides/connect-clickhouse-js

Install the official ClickHouse JavaScript client using npm. Ensure you have Node.js 16.0 or later.

```bash
npm install @clickhouse/client

```

--------------------------------

### Initialize Forward Project with CI/CD Scaffolding

Source: https://www.tinybird.co/docs/forward/install-tinybird/migrate

Generate default CI/CD workflows for a new Forward project in an empty directory. Use `--cicd github` or `--cicd gitlab` for specific templates.

```bash
uvx --from tinybird@latest tb init --type cli --dev-mode manual --folder .
```

--------------------------------

### Example Kafka Topic Partitioning Flow

Source: https://www.tinybird.co/docs/forward/get-data-in/connectors/kafka/guides/partitioning-strategies

Illustrates how Kafka partitions are mapped to ClickHouse® partitions, showing message distribution and part creation within partitions.

```text
Kafka Topic: events (6 partitions)
  ├─ Partition 0 → ClickHouse® partition 202401 (multiple parts)
  ├─ Partition 1 → ClickHouse® partition 202401 (multiple parts)
  ├─ Partition 2 → ClickHouse® partition 202402 (multiple parts)
  └─ ...

```

--------------------------------

### MCP Server Quickstart URL

Source: https://www.tinybird.co/docs/forward/analytics-agents/mcp

Use this URL in your MCP client or agent framework to connect to the Tinybird MCP server. Replace TINYBIRD_TOKEN with your actual Auth Token.

```url
https://mcp.tinybird.co?token=TINYBIRD_TOKEN

```

--------------------------------

### Login and Deploy Project

Source: https://www.tinybird.co/docs/forward/migrations/shared-to-dedicated

Log in to the new Workspace and deploy your project resources. The --check flag validates the deployment before applying it.

```bash
tb login
tb deploy --check
tb deploy

```

--------------------------------

### Example Signed JWT

Source: https://www.tinybird.co/docs/forward/administration/tokens/jwt

This is an example of a fully signed JWT, generated using a payload and a workspace admin token as the signing key.

```text
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ3b3Jrc3BhY2V...
```

--------------------------------

### Initialize a New Tinybird Project

Source: https://www.tinybird.co/docs/forward/dev-reference/commands/tb-init

Run this command to scaffold your project structure, set development mode, and optionally generate CI/CD templates.

```bash
tb init

```

--------------------------------

### Combining Column and Number of Files Partitioning

Source: https://www.tinybird.co/docs/forward/work-with-data/publish-data/sinks/gcs-sink

Mix column-based partitioning with a fixed number of files. This example partitions by customer ID and then splits the data for each customer into 4 files.

```text
invoices/{customer_id}/dump_{4}.csv
```

--------------------------------

### Install TypeScript SDK Globally

Source: https://www.tinybird.co/docs/forward/dev-reference/commands/typescript-sdk-cli

Install the `tinybird` CLI globally using pnpm. This allows you to run `tinybird` commands directly from your terminal.

```bash
pnpm add -g @tinybirdco/sdk
```

--------------------------------

### Example NDJSON Data

Source: https://www.tinybird.co/docs/forward/work-with-data/optimize/guides/deduplication-strategies

This is an example of data in NDJSON format, representing post information with a timestamp, post ID, views, likes, and tags.

```json
{ "timestamp": "2024-07-02T02:22:17", "post_id": 956, "views": 856875, "likes": 2321, "tags": "Sports" }
```

--------------------------------

### Create Staging Deployment in Tinybird Cloud

Source: https://www.tinybird.co/docs/forward/test-and-deploy/deployments/cli

Prepares all resources in Tinybird Cloud for a new staging deployment. Use the `--wait` flag to monitor the deployment process.

```bash
# Prepares all resources in Tinybird Cloud
tb --cloud deployment create --wait

```

--------------------------------

### Start Docker Compose with Exported AWS Credentials

Source: https://www.tinybird.co/docs/forward/get-data-in/connectors/s3

After configuring your `docker-compose.yml`, export your AWS credentials as environment variables and then start the Docker Compose service.

```bash
# Export your credentials
export AWS_ACCESS_KEY_ID="your-access-key-id"
export AWS_SECRET_ACCESS_KEY="your-secret-access-key"
export AWS_DEFAULT_REGION="us-east-1"

# Start Docker Compose
docker compose up -d

```

--------------------------------

### Create Real-time Monitoring Project

Source: https://www.tinybird.co/docs/forward/tinybird-code/workflows

Set up a monitoring project for application logs, including a logs table, an error rate endpoint, a service health dashboard endpoint, and an alert endpoint for error spikes.

```text
Create a monitoring project for application logs:
- Logs table with level, message, timestamp, service
- Error rate endpoint (errors per minute)
- Service health dashboard endpoint
- Alert endpoint for error spikes
```

--------------------------------

### Example Test File Format

Source: https://www.tinybird.co/docs/forward/dev-reference/commands/tb-test

Define test cases in YAML files within the `tests/` directory. Each test includes a name, description, expected HTTP status, parameters, and the expected result.

```yaml
- name: user_actions_clicked
  description: Returns clicked actions only
  expected_http_status: 200
  parameters: action=CLICKED
  expected_result: |
    {"action":"CLICKED"}

```

--------------------------------

### Connect to PostgreSQL on Host Machine (Local Development)

Source: https://www.tinybird.co/docs/forward/get-data-in/table-functions/postgresql

Example query for connecting to a PostgreSQL database running on your host machine from Tinybird Local, using `host.docker.internal` and default secret values.

```sql
NODE get_ids
SQL >
%
SELECT id
FROM postgresql(
  'host.docker.internal:5432',
   '<YOUR_PG_DB>',
   '<YOUR_PG_TABLE>',
   {{ tb_secret('pg_username', '<YOUR_DEFAULT_USERNAME>') }},
   {{ tb_secret('pg_password', '<YOUR_DEFAULT_PWD>') }}
)

TYPE COPY
TARGET_DATASOURCE pg_copy_target_ds

```

--------------------------------

### Start Tinybird Local with Persistent Data

Source: https://www.tinybird.co/docs/forward/install-tinybird/local

Command to start the Tinybird Local container and specify a custom path for data volumes to persist data between sessions.

```bash
tb local start --volumes-path <your/path>

```

--------------------------------

### tb init common equivalents

Source: https://www.tinybird.co/docs/forward/dev-reference/commands/tb-create

Common equivalents for `tb create` using `tb init` for different project configurations.

```bash
tb init --folder tinybird
```

```bash
tb init --dev-mode manual
```

```bash
tb init --cicd github
```

```bash
tb init --cicd gitlab
```

--------------------------------

### Run a SELECT query with row limit and stats

Source: https://www.tinybird.co/docs/forward/dev-reference/commands/tb-sql

This example demonstrates how to use the `--rows_limit` and `--stats` options to control the number of rows returned and display query performance statistics. It retrieves specific columns from the `pipe_stats_rt` table.

```bash
tb sql --rows_limit 5 --stats "SELECT start_datetime, duration, pipe_name from tinybird.pipe_stats_rt"
```

--------------------------------

### Create Preview Branch with Connectors

Source: https://www.tinybird.co/docs/forward/development-workflow/cicd

Use this command to create a temporary preview branch that includes connector data. This is useful for testing changes that interact with Kafka, S3, or GCS.

```bash
tb branch create tmp_ci_my_feature --last-partition --with-connections
```

--------------------------------

### Create Preview Deployments

Source: https://www.tinybird.co/docs/forward/dev-reference/commands/typescript-sdk-cli

Create or replace an ephemeral preview branch and deploy project resources to it. This is useful for CI pipelines. Options include dry-run, checking, specifying a name, or using local mode.

```bash
tinybird preview
```

```bash
tinybird preview --dry-run
```

```bash
tinybird preview --check
```

```bash
tinybird preview --name custom_branch_name
```

```bash
tinybird preview --local
```

--------------------------------

### Example Pipe with Fixed Parameters

Source: https://www.tinybird.co/docs/forward/administration/tokens/jwt

This example shows a Tinybird pipe that accepts a dynamic 'org' parameter. The 'fixed_params' in a JWT can be used to supply this value securely.

```sql
SELECT fieldA, fieldB FROM my_ds WHERE org_id = '{{ String(org) }}'
TYPE ENDPOINT

```

--------------------------------

### Uninstall Tinybird Classic CLI

Source: https://www.tinybird.co/docs/forward/migrations/migrate-from-classic/without-connectors

Use this command to uninstall the Tinybird Classic CLI if it's installed globally. Activate a virtual environment first if installed locally.

```bash
pip uninstall tinybird-cli

```

--------------------------------

### Initialize Forward CLI Project Scaffolding

Source: https://www.tinybird.co/docs/forward/migrations/migrate-from-classic

Generate default CI/CD workflows for a new project in an empty directory. Use `--cicd github` or `--cicd gitlab` for specific CI/CD templates.

```bash
uvx --from tinybird@latest tb init --type cli --dev-mode manual --folder .

```

--------------------------------

### Example Prometheus output

Source: https://www.tinybird.co/docs/forward/work-with-data/publish-data/guides/consume-api-endpoints-in-prometheus-format

This is an example of the output format when a Tinybird pipe endpoint is accessed with the .prometheus extension. It includes help text, type, and metric data with labels.

```prometheus
# HELP http_request_count Total number of HTTP requests
# TYPE http_request_count counter
http_request_count{method="PUT",status_code="203"} 1
http_request_count{method="PATCH",status_code="203"} 1
http_request_count{method="DELETE",status_code="201"} 4
http_request_count{method="POST",status_code="203"} 1
http_request_count{method="OPTIONS",status_code="203"} 1
http_request_count{method="PATCH",status_code="204"} 1
http_request_count{method="PUT",status_code="204"} 1
http_request_count{method="HEAD",status_code="203"} 1
http_request_count{method="GET",status_code="201"} 4
http_request_count{method="POST",status_code="204"} 1
http_request_count{method="GET",status_code="203"} 1
http_request_count{method="POST",status_code="201"} 4
http_request_count{method="DELETE",status_code="204"} 1
http_request_count{method="OPTIONS",status_code="201"} 4
http_request_count{method="GET",status_code="204"} 1
http_request_count{method="PATCH",status_code="201"} 4
http_request_count{method="PUT",status_code="201"} 4
http_request_count{method="DELETE",status_code="203"} 1
http_request_count{method="HEAD",status_code="201"} 4

# HELP http_request_duration_seconds Average HTTP request duration in seconds

```

--------------------------------

### Sample .tinyb File Structure

Source: https://www.tinybird.co/docs/forward/dev-reference/datafiles/tinyb-file

This is a sample .tinyb file structure. It includes fields for host, workspace ID and name, scope, authentication tokens, current working directory, user details, and version.

```json
{
    "host": "<tinybird-host>",
    "id": "<workspace-id>",
    "name": "<workspace-name>",
    "scope": "user",
    "token": "<authentication-token>",
    "tokens": {
        "<tinybird-host>": "<authentication-token>",
        "<another-tinybird-host>": "<authentication-token>"
    },
    "cwd": "<optional-path-to-your-tinybird-folder-e.g-./tinybird>", 
    "user_email": "<user-email>",
    "user_id": "<user-id>",
    "user_token": "<authentication-token>",
    "version": "<tinybird-version>"
}

```

--------------------------------

### Example of Optimized Schema with External Reference

Source: https://www.tinybird.co/docs/forward/get-data-in/connectors/kafka/guides/message-size-handling

An example of a JSON message structure that includes essential data and a reference (S3 key) to a larger payload stored externally.

```json
{
  "user_id": "123",
  "profile_summary": "key points only",
  "full_profile_s3_key": "s3://bucket/profiles/123.json"
}
```

--------------------------------

### Start Tinybird Local with Specific AWS Profile

Source: https://www.tinybird.co/docs/forward/get-data-in/connectors/s3

Specify an AWS profile to use when starting Tinybird Local with the `--use-aws-creds` flag by setting the AWS_PROFILE environment variable.

```bash
AWS_PROFILE=my-profile tb local start --use-aws-creds

```

--------------------------------

### Initialize a project with tinybird init

Source: https://www.tinybird.co/docs/forward/dev-reference/commands/python-sdk-cli

Initialize a new Tinybird project with specified development mode, CI/CD integration, and folder. Use --skip-login to avoid interactive login.

```bash
tinybird init --dev-mode branch --cicd skip --folder tb_project

```

```bash
tinybird init --dev-mode local --cicd github --folder tb_project

```

```bash
tinybird init --dev-mode branch --cicd skip --folder tb_project --skip-login

```

--------------------------------

### List Connections Command

Source: https://www.tinybird.co/docs/forward/dev-reference/datafiles/connection-files

Lists all configured connections in the project using the Tinybird CLI.

```bash
tb connection ls

```

--------------------------------

### Start Development Session from Git Branch

Source: https://www.tinybird.co/docs/forward/development-workflow/cloud-branches

If the branch was created automatically with `tb build` from a Git branch, you can start a development session by simply running `tb dev` from that same Git branch.

```bash
tb dev

```