CLI
Introduction

Mockingbird CLI

The Mockingbird CLI is a node-based CLI tool to invoke Mockingbird.

Installation

The CLI is available from npm (opens in a new tab).

You can install it using npm install -G @tinybirdco/mockingbird-cli

Usage

Commands

Use mockingbird-cli --help to get a list of available commands or

Use mockingbird-cli <command> --help to get a list of available options for a command.

@tinybirdco/mockingbird-cli  ably
@tinybirdco/mockingbird-cli  aws-sns
@tinybirdco/mockingbird-cli  confluent-cloud-kafka
@tinybirdco/mockingbird-cli  tinybird
@tinybirdco/mockingbird-cli  upstash-kafka
@tinybirdco/mockingbird-cli  aws-kinesis
@tinybirdco/mockingbird-cli  google-spanner

Common options

--template   Template to use for populating
  [choices: "Simple Example", "eCommerce Transactions", "Stock Prices", "Flight
    Bookings", "Content Tracking", "Web Analytics Starter Kit", "Log Analytics
                                      Starter Kit", "Sportsbetting"] [default: "Simple Example"]
--schema     Path to schema file
--eps        Events per second                                    [default: 1]
--limit      Max number of rows to send (-1 for unlimited)       [default: -1]
--logs       Enable logs                                       [default: true]

Ably

--apiKey     Ably API Key                                           [required]
--channelId  Ably Channel ID                                        [required]

AWS SNS

--region           AWS Region                                       [required]
--accessKeyId      AWS Access Key ID                                [required]
--secretAccessKey  AWS Secret Access Key                            [required]
--topicArn         AWS SNS Topic ARN                                [required]
--subject          AWS SNS Subject
--snsOptions       AWS SNS Options JSON string

AWS Kinesis

--region           AWS Region                                       [required]
--accessKeyId      AWS Access Key ID                                [required]
--secretAccessKey  AWS Secret Access Key                            [required]
--streamName       AWS Kinesis Stream Name                          [required]
--partitionKey     AWS Kinesis Partition Key
--kinesisOptions   AWS Kinesis Options JSON string

Confluent Cloud Kafka

--restEndpoint  Confluent Cloud Kafka REST endpoint                 [required]
--clusterId     Confluent Cloud Kafka cluster ID                    [required]
--topic         Confluent Cloud Kafka topic                         [required]
--apiKey        Confluent Cloud Kafka API Key                       [required]
--apiSecret     Confluent Cloud Kafka API Secret                    [required]
--headers       Confluent Cloud Kafka headers JSON string
--key           Confluent Cloud Kafka key JSON string

Google Spanner

--projectId     Google Cloud project ID                              [required]
--instanceId    Google Cloud Spanner instance ID                     [required]
--databaseId    Google Cloud Spanner database ID                     [required]
--table         Google Cloud Spanner table                           [required]
--keyFilename   Google Cloud Spanner key filename                    [required]

Tinybird

--endpoint    API endpoint name
                            [required] [choices: "gcp_europe_west3", "gcp_us_east4", "aws_eu_central_1", "aws_us_east_1", "aws_us_west_2", "custom"]
--datasource  Datasource name                                       [required]
--token       API token                                             [required]

Upstash Kafka

--address   Upstash Kafka address                                   [required]
--user      Upstash Kafka user                                      [required]
--pass      Upstash Kafka password                                  [required]
--topic     Upstash Kafka topic                                     [required]

Example

As an example, to send data to Tinybird, in the EU region, using the Stock Prices template, to a Data Source called stocks, at 100 Events Per Second:

mockingbird-cli tinybird --datasource=stocks --token=e.pXXX --endpoint=gcp_europe_west3 --template "Stock Prices" --eps 100
Aws KinesisIntroduction