### Configure Tap-Slack Interactively in Meltano

Source: https://hub.meltano.com/extractors/tap-slack--meltanolabs

Launches an interactive wizard for configuring tap-slack settings in Meltano. The command prompts for each configuration parameter with built-in validation and help text. This guided approach simplifies setup for new users and ensures proper configuration.

```bash
meltano config tap-slack set --interactive
```

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

### List Tap-Slack Configuration Settings

Source: https://hub.meltano.com/extractors/tap-slack--meltanolabs

Displays all available tap-slack settings with their environment variables and default values. The output includes setting descriptions to help understand configuration options. This command is useful for troubleshooting and documentation purposes.

```bash
meltano config tap-slack list
```

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

### Launch Superset UI (Bash)

Source: https://hub.meltano.com/utilities/superset--apache

Starts the Superset web UI via Meltano, defaulting to http://localhost:8088. Requires prior setup steps. Input is none; output is accessible web app. Configurable via ui settings in Meltano.

```bash
meltano invoke superset:ui
```

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

### Meltano Superset Utility Commands

Source: https://hub.meltano.com/utilities/superset

The superset utility in Meltano supports various commands that can be invoked using 'meltano invoke'. These commands include actions like creating an admin user, describing the Superset instance, initializing it, invoking other commands, loading examples, and starting the UI.

```bash
meltano invoke superset:create-admin [args...]
```

```bash
meltano invoke superset:describe [args...]
```

```bash
meltano invoke superset:initialize [args...]
```

```bash
meltano invoke superset:invoke [args...]
```

```bash
meltano invoke superset:load-examples [args...]
```

```bash
meltano invoke superset:ui [args...]
```

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

### Load Example Data in Superset (Bash)

Source: https://hub.meltano.com/utilities/superset--apache

Loads example datasets into Superset for testing, equivalent to superset load_examples. Requires admin user created. Input is none; output is examples loaded in UI. Optional step for new users.

```bash
meltano invoke superset:load-examples
```

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

### Meltano CLI Commands for Tap-Slack Installation and Configuration

Source: https://hub.meltano.com/extractors/tap-slack

Series of commands to add, configure, test, and manage settings for the tap-slack extractor in Meltano. Dependencies: Meltano installed. Inputs: Interactive prompts or specific values for settings like api_key. Outputs: Configured extractor ready for EL pipelines. Limitations: Requires valid Slack API key; some settings like channel_types need array inputs.

```shell
meltano add tap-slack

```

```shell
meltano config tap-slack set --interactive

```

```shell
meltano config tap-slack test

```

```shell
meltano config tap-slack list

```

```shell
meltano config tap-slack set api_key [value]

```

```shell
meltano config tap-slack set auto_join_channels [value]

```

```shell
meltano config tap-slack set channel_types [value]

```

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

### Install Tap-Slack Extractor with Meltano

Source: https://hub.meltano.com/extractors/tap-slack--meltanolabs

Adds the tap-slack extractor to your Meltano project. This command installs the plugin and registers it in the meltano.yml configuration file. It is compatible with Meltano 3.8+ and legacy versions.

```bash
meltano add tap-slack
```

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

### Initialize Superset Configuration and Database

Source: https://hub.meltano.com/utilities/superset

Commands to initialize the Superset configuration, database, and generate a new secret key for enhanced security. This is a crucial step for first-time setup.

```bash
# create a new secret key
meltano config superset set SECRET_KEY $(openssl rand -base64 42)
# create the initial config, database, and auth roles.
meltano invoke superset:initialize
```

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

### Start Matatika Lab Interface

Source: https://hub.meltano.com/utilities/matatika

Starts the Matatika Lab web interface integrated with your Meltano project. On first execution, this command pulls required Docker images from Docker Hub which may take several minutes. Subsequent starts launch the application at localhost:8080 within 30 seconds and automatically open a browser tab.

```shell
meltano invoke matatika lab
```

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

### Example Tap Configuration File (config.json)

Source: https://hub.meltano.com/singer/spec

Illustrates a typical JSON configuration file for a Meltano tap. It includes essential fields like API keys, start dates for historical data pulls (RFC3339 format), and user agent information for API provider contact.

```json
# config.json
{
  "api_key" : "asd23ayzxz80adf",
  "start_date" : "2022-01-01T00:00:00Z",
  "user_agent" : "your_email@domain"
}
```

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

### Add Hub Planner Extractor to Meltano Project

Source: https://hub.meltano.com/extractors/tap-hubplanner

Install the tap-hubplanner extractor in an existing Meltano project using the add command. This downloads the necessary components and integrates the extractor. Requires Meltano to be installed and a project created; no additional inputs are needed, and it outputs confirmation of successful addition. Note that Docker must be available if using the Airbyte variant.

```shell
meltano add tap-hubplanner
```

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

### Create Slack App Manifest for Tap-Slack Integration

Source: https://hub.meltano.com/extractors/tap-slack--meltanolabs

Defines the YAML manifest for creating a Slack app with required OAuth scopes for tap-slack data extraction. Specifies permissions for channels, users, and messages. Configures bot user settings and disables advanced features like socket mode and token rotation.

```yaml
_metadata:
  major_version: 1
  minor_version: 1
display_information:
  name: MeltanoLabs Tap-Slack
  description: Slack App to support the implementation of Singer.io tap-slack
  long_description: This application is used for extracting channel, user, and message data from the Slack workspace via the tap-slack application. Found on GitHub at https://github.com/MeltanoLabs/tap-slack.
features:
  bot_user:
    display_name: MeltanoLabs Tap-Slack
    always_online: false
oauth_config:
  redirect_urls:
    - https://meltano.com/
  scopes:
    bot:
      - channels:join
      - channels:history
      - channels:read
      - users:read
      - users:read.email
settings:
  org_deploy_enabled: false
  socket_mode_enabled: false
  token_rotation_enabled: false
```

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

### Set Start Date

Source: https://hub.meltano.com/extractors/tap-freshdesk--airbyte

Command to set the start date for data replication in the tap-freshdesk extractor configuration.

```bash
meltano config tap-freshdesk set airbyte_config start_date [value]
```

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

### Configure Specific tap-prometheus Settings

Source: https://hub.meltano.com/extractors/tap-prometheus--meshcloud

Examples of how to configure specific settings for the tap-prometheus extractor using the Meltano CLI. This includes setting authentication, endpoint, metrics definitions, and start date.

```bash
meltano config tap-prometheus set auth password [value]
```

```bash
meltano config tap-prometheus set auth username [value]
```

```bash
meltano config tap-prometheus set endpoint [value]
```

```bash
meltano config tap-prometheus set metrics [value]
```

```bash
meltano config tap-prometheus set start_date [value]
```

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

### Add tap-punk-api extractor to Meltano project

Source: https://hub.meltano.com/extractors/tap-punk-api

Installs the tap-punk-api extractor plugin into a Meltano project. This command registers the plugin and makes it available for configuration and execution. Requires Meltano to be installed and a Meltano project to be initialized.

```bash
meltano add tap-punk-api
```

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

### Set Individual Tap-Slack Configuration Values

Source: https://hub.meltano.com/extractors/tap-slack--meltanolabs

Commands to set specific tap-slack configuration values individually in Meltano. Each command updates a single setting in your meltano.yml file by name with a provided value. Use these to configure the API key, channel joining behavior, and channel types after initial setup.

```bash
meltano config tap-slack set api_key [value]
meltano config tap-slack set auto_join_channels [value]
meltano config tap-slack set channel_types [value]
```

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

### Test Tap-Slack Configuration Validity

Source: https://hub.meltano.com/extractors/tap-slack--meltanolabs

Validates tap-slack configuration settings and API connectivity before running extractions. The command checks authentication, required parameters, and Slack API permissions. It helps identify and resolve configuration issues early in the setup process.

```bash
meltano config tap-slack test
```

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

### Debug Tap Invocation Command

Source: https://hub.meltano.com/extractors/tap-spreadsheets-anywhere

Runs the tap in development mode for verbose error logging during syncing issues. Requires Meltano installed with the tap; inputs are optional I/O flags; outputs detailed logs. Helps troubleshoot without full sync.

```bash
meltano invoke tap-spreadsheets-anywhere --dev
```

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

### List tap-zendesk-sell settings via shell

Source: https://hub.meltano.com/extractors/tap-zendesk-sell--airbyte

Retrieves and displays all known settings for tap-zendesk-sell in Meltano. No dependencies beyond Meltano installation. No inputs, outputs a list of setting names. Limitation: None beyond Meltano being available.

```shell
meltano config tap-zendesk-sell list

```

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

### Install Datahub utility with plugins

Source: https://hub.meltano.com/utilities/datahub

Command to reinstall the datahub utility after updating plugin definitions. Required when adding new metadata source plugins.

```bash
meltano install utility datahub
```

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

### Set File Path Setting

Source: https://hub.meltano.com/utilities/elementary

Provides an example of how to configure the `file-path` setting for elementary using the `meltano config` command.

```bash
meltano config elementary set file-path [value]
```

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

### Test Slack API Access with Curl Command

Source: https://hub.meltano.com/extractors/tap-slack--meltanolabs

Validates Slack API token access to the conversations.list endpoint using curl. Sends a GET request with Bearer authentication to retrieve channel information. Replace the placeholder with your actual API token to verify connectivity and permissions.

```bash
curl -X GET -H 'Authorization: Bearer <Your Token>' https://slack.com/api/conversations.list?exclude_archived=False
```

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

### Set Tables Configuration Command

Source: https://hub.meltano.com/extractors/tap-spreadsheets-anywhere

Meltano command to directly set the tables configuration for tap-spreadsheets-anywhere. Replace [value] with the YAML config string; useful for programmatic setup. Outputs updated config; no limitations beyond valid YAML input.

```bash
meltano config tap-spreadsheets-anywhere set tables [value]
```

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

### Slack App Manifest YAML Configuration

Source: https://hub.meltano.com/extractors/tap-slack

Defines the configuration for a Slack app to enable access to workspace records via the tap-slack extractor. Requires Slack API scopes for channels, users, and history. Inputs: YAML manifest file. Outputs: Configurable Slack bot app. Limitations: Additional scopes needed for direct messages or private channels; app must be installed in the workspace.

```yaml
_metadata:
  major_version: 1
  minor_version: 1
display_information:
  name: MeltanoLabs Tap-Slack
  description: Slack App to support the implementation of Singer.io tap-slack
  long_description: This application is used for extracting channel, user, and message data from the Slack workspace via the tap-slack application. Found on GitHub at https://github.com/MeltanoLabs/tap-slack.
features:
  bot_user:
    display_name: MeltanoLabs Tap-Slack
    always_online: false
oauth_config:
  redirect_urls:
    - https://meltano.com/
  scopes:
    bot:
      - channels:join
      - channels:history
      - channels:read
      - users:read
      - users:read.email
settings:
  org_deploy_enabled: false
  socket_mode_enabled: false
  token_rotation_enabled: false

```

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

### Meltano Catalog Structure Example

Source: https://hub.meltano.com/singer/spec

This JSON object represents a complete catalog example for Meltano. It defines streams, their schemas, and metadata for inclusion and validation.

```json
{
  "streams": [
    {
      "stream": "tools",
      "tap_stream_id": "tools",
      "schema": {
        "type": ["null", "object"],
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": [
              "string"
            ]
          },
          "name": {
            "type": [
              "string"
            ]
          },
          "updated_at": {
            "type": [
              "string"
            ],
            "format": "date-time"
          }
        }
      }
    }
  ],
  "metadata": [
    {
      "metadata": {
        "inclusion": "available",
        "table-key-properties": ["id"],
        "selected": true,
        "valid-replication-keys": ["date_modified"],
        "schema-name": "users"
      },
      "breadcrumb": []
    },
    {
      "metadata": {
        "inclusion": "automatic"
      },
      "breadcrumb": ["properties", "id"]
    },
    {
      "metadata": {
        "inclusion": "available",
        "selected": true
      },
      "breadcrumb": ["properties", "name"]
    },
    {
      "metadata": {
        "inclusion": "automatic"
      },
      "breadcrumb": ["properties", "updated_at"]
    }
  ]
}
```

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

### Add Matatika Utility to Meltano Project

Source: https://hub.meltano.com/utilities/matatika

Installs the matatika utility extension into a Meltano project using the meltano add command. This command registers the utility with your project, making it available for configuration and invocation. Requires Meltano CLI to be installed and a Meltano project to be initialized.

```shell
meltano add matatika
```

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

### Install tap-freshdesk with Meltano

Source: https://hub.meltano.com/extractors/tap-freshdesk--airbyte

Command to add the tap-freshdesk extractor to your Meltano project. Requires Meltano 3.8+ and Docker.

```bash
meltano add tap-freshdesk --variant airbyte
```

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

### Install Meltano Tap for Harvest Forecast

Source: https://hub.meltano.com/extractors/tap-harvest-forecast

This command installs the Harvest Forecast tap using the Meltano CLI. Ensure Meltano is installed and configured before running this command. This is the primary method for adding the tap to your Meltano project.

```bash
meltano add tap-harvest-forecast
```

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

### Configure Datahub plugin with extras in YAML

Source: https://hub.meltano.com/utilities/datahub

Example YAML configuration showing how to specify additional plugins for the datahub utility in meltano.yml.

```yaml
utilities:
- name: datahub
  variant: datahub-project
  pip_url: acryl-datahub[rest,mongodb,metabase,bigquery,bigquery-usage,dbt]
```

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

### Install tap-dynamics extractor

Source: https://hub.meltano.com/extractors/tap-dynamics--singer-io

Adds the tap-dynamics extractor to your Meltano project. This command installs the Singer variant of the tap-dynamics extractor.

```bash
meltano add tap-dynamics --variant singer-io
```

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

### Configure tap-punk-api settings interactively

Source: https://hub.meltano.com/extractors/tap-punk-api

Launches an interactive prompt to configure tap-punk-api settings. This command guides users through setting required and optional parameters step-by-step. The configuration is stored in the project's meltano.yml file.

```bash
meltano config tap-punk-api set --interactive
```

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

### Add tap-zendesk Extractor

Source: https://hub.meltano.com/extractors/tap-zendesk--hotgluexyz

This command installs the tap-zendesk extractor using Meltano. It specifies the version and variant to be installed. Ensure Meltano is installed and configured in your environment.

```bash
meltano add tap-zendesk --variant hotgluexyz
```

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

### Set start date for tap-dynamics

Source: https://hub.meltano.com/extractors/tap-dynamics--singer-io

Configures the default bookmark value for endpoints without existing bookmarks. Replace [value] with your start date.

```bash
meltano config tap-dynamics set start_date [value]
```

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

### Install Datahub utility in Meltano

Source: https://hub.meltano.com/utilities/datahub

Command to add the datahub utility to a Meltano project. Requires Meltano 3.8+ or legacy versions.

```bash
meltano add datahub
```

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

### Configure tap-greenhouse Settings Interactively

Source: https://hub.meltano.com/extractors/tap-greenhouse--airbyte

Command to start an interactive configuration process for the tap-greenhouse extractor settings. This allows users to set parameters step-by-step.

```bash
meltano config tap-greenhouse set --interactive
```

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

### Set Slack Channel Name Setting

Source: https://hub.meltano.com/utilities/elementary

Provides an example of setting the `slack-channel-name` setting.

```bash
meltano config elementary set slack-channel-name [value]
```

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

### Generate SECRET_KEY for Superset (Bash)

Source: https://hub.meltano.com/utilities/superset--apache

Sets a new SECRET_KEY for Superset using OpenSSL to enhance security. Requires OpenSSL installed on the system. Input is none; output is the generated key set in config. Recommended for first-time setups.

```bash
meltano config superset set SECRET_KEY $(openssl rand -base64 42)
```

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

### Add tap-zendesk-sell to Meltano project via shell

Source: https://hub.meltano.com/extractors/tap-zendesk-sell--airbyte

Adds the tap-zendesk-sell extractor to a Meltano project using the Airbyte variant. Requires Meltano to be installed and a project created. Takes no direct input beyond the command, outputs installation success or error. Limitation: Fails if Docker is not running or Meltano version is below 2.13.0.

```shell
meltano add tap-zendesk-sell --variant airbyte

```

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

### Install tap-whisky-hunter extractor

Source: https://hub.meltano.com/extractors/tap-whisky-hunter

Adds the tap-whisky-hunter extractor to your Meltano project. Requires Docker to be installed and running for Airbyte container execution.

```bash
meltano add tap-whisky-hunter
```

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

### Configure Matatika Utility Interactively

Source: https://hub.meltano.com/utilities/matatika

Launches an interactive configuration wizard for the matatika utility settings. This guided prompt interface helps users configure required parameters without manually editing configuration files. Assumes the matatika utility has already been added to the Meltano project.

```shell
meltano config matatika set --interactive
```

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

### Example Google Analytics Reports Configuration

Source: https://hub.meltano.com/extractors/tap-ga4

An example demonstrating how to define specific streams for user statistics per day and session statistics per day and country. This illustrates the practical application of the JSON structure.

```json
[
  {
    "name" : "users_per_day",
    "dimensions" :
    [
      "date"
    ],
    "metrics" :
    [
      "newUsers",
      "active1DayUsers"
    ]
  },
  {
    "name" : "sessions_per_country_day",
    "dimensions" :
    [
      "date",
      "country"
    ],
    "metrics" :
    [
      "sessions",
      "sessionsPerUser",
      "avgSessionDuration"
    ]
  }
]
```

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

### Basic S3 CSV Table Configuration in Meltano

Source: https://hub.meltano.com/extractors/tap-spreadsheets-anywhere

Configures a table to sync CSV files from an S3 bucket using specified patterns, delimiters, and sampling rates. Requires Meltano with tap-spreadsheets-anywhere installed; inputs include path, format, key properties, and date filters; outputs synced records to a target table. Limitations: Sampling may miss rare data types like floats.

```yaml
config:
  tables:
  - path: s3://my-s3-bucket
    name: target_table_name
    pattern: subfolder/common_prefix.*
    start_date: 2017-05-01T00:00:00Z
    key_properties: []
    format: csv
    delimiter: "|"
    quotechar: '"'
    universal_newlines: false
    sample_rate: 10
    max_sampling_read: 2000
    max_sampled_files: 3
    prefer_number_vs_integer: true
    selected: true
```

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

### Example Google Analytics Reports Definition

Source: https://hub.meltano.com/extractors/tap-ga4--meltanolabs

An example of the JSON structure for TAP_GA4_REPORTS, demonstrating how to define streams for daily user statistics and daily/country session statistics.

```json
[
  {
    "name": "users_per_day",
    "dimensions": [
      "date"
    ],
    "metrics": [
      "newUsers",
      "active1DayUsers"
    ]
  },
  {
    "name": "sessions_per_country_day",
    "dimensions": [
      "date",
      "country"
    ],
    "metrics": [
      "sessions",
      "sessionsPerUser",
      "avgSessionDuration"
    ]
  }
]
```

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

### Singer Message Examples in JSON

Source: https://hub.meltano.com/singer/spec

This snippet demonstrates example JSON messages for Singer data exchange, including schema, record, and state types for users and locations streams. It shows the required format for taps to output to stdout, with each message on a single line. No specific dependencies are needed beyond JSON parsing capabilities.

```json
{"type": "SCHEMA", "stream": "users", "key_properties": ["id"], "schema": {"required": ["id"], "type": "object", "properties": {"id": {"type": "integer"}}}}
{"type": "RECORD", "stream": "users", "record": {"id": 1, "name": "Chris"}}
{"type": "RECORD", "stream": "users", "record": {"id": 2, "name": "Mike"}}
{"type": "SCHEMA", "stream": "locations", "key_properties": ["id"], "schema": {"required": ["id"], "type": "object", "properties": {"id": {"type": "integer"}}}}
{"type": "RECORD", "stream": "locations", "record": {"id": 1, "name": "Philadelphia"}}
{"type": "STATE", "value": {"users": 2, "locations": 1}}
```

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

### Configure tap-prometheus interactively

Source: https://hub.meltano.com/extractors/tap-prometheus

Launches an interactive wizard to configure tap-prometheus settings. Guides users through required and optional parameters with prompts. Provides a user-friendly alternative to manual configuration via command line.

```shell
meltano config tap-prometheus set --interactive
```

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

### tap-prometheus Metrics Configuration Example

Source: https://hub.meltano.com/extractors/tap-prometheus--meshcloud

A sample YAML configuration for the 'metrics' setting in tap-prometheus. This demonstrates how to define individual Prometheus metric query streams, including query, batch size, step, and label schema.

```yaml
- name: online_peak
  query: sum(sessions_count)
  batch: '10000'
  step: 120s
  labels:
    type: object
    properties:
      customer:
        type: string
      environment:
        type: string

```

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

### Install tap-postgres using Meltano CLI

Source: https://hub.meltano.com/extractors/tap-postgres

Install the tap-postgres extractor in a Meltano project. Requires Meltano version 3.8 or later. This command adds the plugin to the project without arguments.

```bash
meltano add tap-postgres
```

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

### Configure tap-firebolt Extractor Interactively

Source: https://hub.meltano.com/extractors/tap-firebolt

Opens an interactive prompt to configure the settings for the tap-firebolt extractor. This is the recommended method for initial setup.

```bash
meltano config tap-firebolt set --interactive
```

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

### Meltano CLI Commands for Google Analytics Tap Configuration

Source: https://hub.meltano.com/extractors/tap-google-analytics--meltanolabs

These bash commands use the Meltano CLI to set configuration properties for the tap-google-analytics, such as OAuth credentials, key file location, reports, start date, and view ID. They require Meltano installed and the tap added; inputs are property values like file paths or tokens, updating the local Meltano config. Limitations include dependency on valid Google API credentials and up to 7 dimensions/10 metrics per report.

```bash
meltano config tap-google-analytics set key_file_location [value]
```

```bash
meltano config tap-google-analytics set oauth_credentials client_id [value]
```

```bash
meltano config tap-google-analytics set oauth_credentials client_secret [value]
```

```bash
meltano config tap-google-analytics set oauth_credentials refresh_token [value]
```

```bash
meltano config tap-google-analytics set reports [value]
```

```bash
meltano config tap-google-analytics set reports_list [value]
```

```bash
meltano config tap-google-analytics set start_date [value]
```

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

### Meltano TAP REST API SDK YAML Configuration Example

Source: https://hub.meltano.com/extractors/tap-rest-api-msdk

An example of a Meltano YAML configuration file for the tap-rest-api-msdk, demonstrating how to set API URLs, define streams with parameters, specify primary keys, and select data fields. This configuration is used for extracting earthquake data from USGS.

```yaml
- name: tap-rest-api-msdk
  variant: widen
  pip_url: tap-rest-api-msdk
  config:
    api_url: https://earthquake.usgs.gov/fdsnws
    streams:
    - name: us_earthquakes
      params:
        format: geojson
        starttime: '2022-12-07'
        endtime: '2022-12-08'
        minmagnitude: 1
      path: /event/1/query
      primary_keys:
      - id
      records_path: $.features[*]
      num_inference_records: 200
  select:
  - '*.*'
```

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

### Example State File Content (state.json)

Source: https://hub.meltano.com/singer/spec

Shows the structure of a state file used by taps to resume replication from a previous point. The content mirrors the 'value' property of a state message, typically containing a 'bookmarks' object.

```json
# state.json
{
  "bookmarks": {
    "tools": {
      "updated_at": "2021-10-20T16:45:33.000Z"
    },
    "team": {
      "id": 123
    }
  }
}
```

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

### Install tap-ga4 using Meltano CLI

Source: https://hub.meltano.com/extractors/tap-ga4--meltanolabs

Command to install the tap-ga4 extractor using the Meltano CLI. Requires Meltano version v3.8 or later.

```bash
meltano add tap-ga4
```

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

### Install Superset with Custom pip_url (Bash)

Source: https://hub.meltano.com/utilities/superset--apache

Re-installs the Superset utility after updating its pip_url for additional database drivers like Snowflake. Requires meltano.yml updated with pip_url. Input is updated config; output is installed plugin with new dependencies.

```bash
meltano install utility superset
```

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

### Configure streams in YAML

Source: https://hub.meltano.com/extractors/tap-smoke-test

YAML configuration example showing how to define streams in meltano.yml. Includes stream name, input filename for mock data, and optional exception simulation settings.

```yaml
streams:
- stream_name: animals
  input_filename: https://raw.githubusercontent.com/meltano/tap-smoke-test/main/demo-data/animals-data.jsonl
```

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

### Meltano Command: Set Start Date

Source: https://hub.meltano.com/extractors/tap-google-analytics

Configures the start date for extracting historical data from Google Analytics. A larger date range will result in a longer initial extraction time.

```bash
meltano config tap-google-analytics set start_date [value]
```

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

### JSON Example: Google Analytics Reports

Source: https://hub.meltano.com/extractors/tap-google-analytics

An example JSON structure for defining Google Analytics reports, illustrating how to configure streams for daily users and daily sessions per country.

```json
[
  {
    "name" : "users_per_day",
    "dimensions" :
    [
      "ga:date"
    ],
    "metrics" :
    [
      "ga:users",
      "ga:newUsers"
    ]
  },
  {
    "name" : "sessions_per_country_day",
    "dimensions" :
    [
      "ga:date",
      "ga:country"
    ],
    "metrics" :
    [
      "ga:sessions",
      "ga:sessionsPerUser",
      "ga:avgSessionDuration"
    ]
  }
]
```

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

### Invoke Matatika Lab Command

Source: https://hub.meltano.com/utilities/matatika

Alternative syntax to start the Matatika Lab using the namespace:command format preferred by the Extension Developer Kit. This command is functionally equivalent to 'meltano invoke matatika lab' but follows EDK conventions. Supports optional arguments for customizing lab startup behavior such as disabling browser auto-open.

```shell
meltano invoke matatika:lab [args...]
```

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

### Invoke Elementary: Initialize

Source: https://hub.meltano.com/utilities/elementary

Shows how to invoke the `initialize` command using `meltano invoke`.

```bash
meltano invoke elementary:initialize [args...]
```

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

### Example Reports JSON String for tap-workday-raas

Source: https://hub.meltano.com/extractors/tap-workday-raas

An example of the JSON string format required for the 'reports' setting. This string defines the reports to extract, including their names and URLs. The input is processed by `json.loads()`, so proper JSON escaping is necessary.

```json
[{"report_name": "abitrary_name", "report_url": "https://..."}, ...]
```

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

### Install Meltano TAP REST API SDK

Source: https://hub.meltano.com/extractors/tap-rest-api-msdk

Command to add the tap-rest-api-msdk extractor to your Meltano project. Requires Meltano version 3.8 or later.

```bash
meltano add tap-rest-api-msdk
```

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

### List tap-freshdesk settings

Source: https://hub.meltano.com/extractors/tap-freshdesk--airbyte

Command to list all known settings for the tap-freshdesk extractor in your Meltano project.

```bash
meltano config tap-freshdesk list
```

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

### Parse Log Output with Interspersed Metrics (Example)

Source: https://hub.meltano.com/singer/spec

This example demonstrates a realistic log output from a system where informational messages are mixed with structured JSON logs, including metrics. Programmatic parsing is required to separate and process these different log types.

```text
INFO Using API Token authentication.
INFO tickets: Skipping - not selected
{"type": "SCHEMA", "stream": "groups", "schema": {"properties": {"name": {"type": ["string"]}, "created_at": {"format": "date-time", "type": ["string"]}, "url": {"type": ["string"]}, "updated_at": {"format": "date-time", "type": ["string"]}, "deleted": {"type": ["boolean"]}, "id": {"type": ["integer"]}}, "type": ["object"]}, "key_properties": ["id"]}
INFO groups: Starting sync
INFO METRIC: {"type": "timer", "metric": "http_request_duration", "value": 0.6276309490203857, "tags": {"status": "succeeded"}}
{"type": "RECORD", "stream": "groups", "record": {"id": 360007960773, "updated_at": "2020-01-09T09:57:16.000000Z"}}
{"type": "STATE", "value": {"bookmarks": {"groups": {"updated_at": "2020-01-09T09:57:16Z"}}}}
```

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

### Example Catalog File Structure

Source: https://hub.meltano.com/singer/spec

Defines the structure of a catalog file used by Meltano taps, specifying data streams and their schemas. It includes required properties like 'stream', 'tap_stream_id', and 'schema', along with optional ones like 'table_name' and 'metadata'.

```json
{
  "streams": [
    {
      "stream": "tools",
      "tap_stream_id": "tools",
      "schema": {
        "type": ["null", "object"],
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": [
              "string"
            ]
          },
          "name": {
            "type": [
              "string"
            ]
          },
          "updated_at": {
            "type": [
              "string"
            ],
            "format": "date-time"
          }
        }
      }
    }
  ]
}
```

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

### Install tap-zendesk Plugin

Source: https://hub.meltano.com/extractors/tap-zendesk--twilio-labs

Command to add the tap-zendesk extractor to your Meltano project. Requires Meltano version v3.8 or later.

```bash
meltano add tap-zendesk
```

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

### Set tap-nytimes start date configuration

Source: https://hub.meltano.com/extractors/tap-nytimes

Sets the start date for article retrieval from Nytimes (format YYYY-MM). This defines when the data extraction should begin.

```bash
meltano config tap-nytimes set airbyte_config start_date [value]
```

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

### Configure BigQuery Adapter

Source: https://hub.meltano.com/utilities/elementary

Demonstrates how to configure a BigQuery adapter, a common requirement for the elementary utility. It shows the `pip_url` and default profile directory.

```yaml
pip_url: elementary-data[bigquery] git+https://github.com/potloc/elementary-ext.git
config:
  profiles_dir: ${MELTANO_PROJECT_ROOT}/transform/profiles/
```

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

### Example State Message Structure

Source: https://hub.meltano.com/singer/spec

Demonstrates the recommended JSON structure for state messages, including a 'bookmarks' object to track replication progress for different data streams. The 'value' property holds the state information.

```json
{
  "type": "STATE",
  "value": {
    "bookmarks": {
      "tools": {
        "updated_at": "2021-10-20T16:45:33.000Z"
      },
      "team": {
        "id": 123
      }
    }
  }
}
```

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

### Create Admin User for Superset (Bash)

Source: https://hub.meltano.com/utilities/superset--apache

Creates an admin user in Superset for UI access, equivalent to superset fab create-admin. Requires Superset plugin initialized. Input is user credentials; output is created user. Use 'admin' as username to load examples.

```bash
meltano invoke superset:create-admin
```

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

### Set Profiles Directory Setting

Source: https://hub.meltano.com/utilities/elementary

Shows how to configure the `profiles-dir` setting, important for dbt project integration.

```bash
meltano config elementary set profiles-dir [value]
```

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

### List tap-mysql Configuration Settings

Source: https://hub.meltano.com/extractors/tap-mysql

This command demonstrates how to list all available configuration settings for the tap-mysql connector using the Meltano CLI. This is useful for understanding the full range of options and their default values.

```bash
meltano config tap-mysql list

```

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

### Configure tap-smoke-test interactively

Source: https://hub.meltano.com/extractors/tap-smoke-test

Interactive configuration command that prompts users to set required and optional settings for the tap-smoke-test extractor. Used after installation to customize the plugin behavior.

```shell
meltano config tap-smoke-test set --interactive
```

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

### Configure target-snowflake settings interactively (CLI)

Source: https://hub.meltano.com/loaders/target-snowflake--transferwise

Command to initiate interactive configuration for the target-snowflake plugin. This allows users to set plugin settings through a guided process.

```bash
meltano config target-snowflake set --interactive

```

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

### List elementary Settings

Source: https://hub.meltano.com/utilities/elementary

This snippet shows how to list the available settings for the elementary utility using `meltano config`. This is useful for understanding configuration options.

```bash
meltano config elementary list
```

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

### Install tap-csv Extractor with Meltano

Source: https://hub.meltano.com/extractors/tap-csv

Command to add the tap-csv extractor to a Meltano project. This is a prerequisite for configuring and using the extractor.

```bash
meltano add tap-csv
```

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

### Invoke Elementary: Describe

Source: https://hub.meltano.com/utilities/elementary

Shows how to invoke the `describe` command using `meltano invoke`.

```bash
meltano invoke elementary:describe [args...]
```

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

### Configure elementary Settings

Source: https://hub.meltano.com/utilities/elementary

Shows how to configure the elementary settings using `meltano config`. The interactive mode allows for setting values through prompts.

```bash
meltano config elementary set --interactive
```

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

### Install Criteo Tap Extractor using Meltano CLI

Source: https://hub.meltano.com/extractors/tap-criteo--edgarrmondragon

Command to add the tap-criteo extractor to your Meltano project. This is a prerequisite for configuring and using the extractor.

```bash
meltano add tap-criteo
```

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

### Configure tap-ga4 Start Date using Meltano CLI

Source: https://hub.meltano.com/extractors/tap-ga4--meltanolabs

Command to set the earliest record date for data synchronization using the Meltano CLI. This corresponds to the TAP_GA4_START_DATE environment variable.

```bash
meltano config tap-ga4 set start_date [value]
```

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

### Create Superset Admin User

Source: https://hub.meltano.com/utilities/superset--meltano

Creates an administrative user for Superset through interactive prompts. Using 'admin' as the username is recommended to enable loading of example data sets.

```shell
# add a superset admin using prompting for required values
meltano invoke superset:create-admin
```

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

### List tap-sumologic Extractor Settings

Source: https://hub.meltano.com/extractors/tap-sumologic

This command lists all the configurable settings for the `tap-sumologic` extractor, including environment variables and default values. It's useful for understanding available options.

```bash
meltano config tap-sumologic list
```

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

### JSON structure for 'files' setting

Source: https://hub.meltano.com/extractors/tap-csv

Example JSON structure for the `files` setting in tap-csv, detailing entity name, file path, key columns, and optional encoding.

```json
[
  {
    "entity": "<entity>",
    "path": "<path>",
    "keys": ["<key>"],
    "encoding": "<encoding>" 
  }
]
```

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

### List Hub Planner Extractor Settings in Meltano

Source: https://hub.meltano.com/extractors/tap-hubplanner

Display all available configurable settings for the tap-hubplanner extractor using the config list command. This provides an overview of options like API keys and Docker settings. Requires the extractor to be added; no inputs needed, outputs a list of settings with descriptions. Useful for reviewing defaults and overrides in meltano.yml.

```shell
meltano config tap-hubplanner list
```

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

### Install tap-smoke-test extractor

Source: https://hub.meltano.com/extractors/tap-smoke-test

Command to add the tap-smoke-test extractor plugin to a Meltano project. This enables the plugin for use in data integration pipelines. Requires Meltano 3.8+ or legacy versions.

```shell
meltano add tap-smoke-test
```

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

### List tap-whisky-hunter settings

Source: https://hub.meltano.com/extractors/tap-whisky-hunter

Displays all available configuration settings for the tap-whisky-hunter extractor including both Airbyte and SDK settings.

```bash
meltano config tap-whisky-hunter list
```

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

### JSON structure for 'csv_files_definition'

Source: https://hub.meltano.com/extractors/tap-csv

Example JSON structure used for the `csv_files_definition` setting, defining entities, paths, and keys for CSV files.

```json
[
  {
    "entity": "<entity>",
    "path": "<path>",
    "keys": ["<key>"]
  }
  // ...
]
```

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

### Example Metadata Structure for Streams and Properties

Source: https://hub.meltano.com/singer/spec

This JSON structure demonstrates how metadata is applied to streams and their properties. The 'breadcrumb' key specifies whether the metadata applies to the entire stream (empty list) or a specific property (e.g., ['properties', 'id']). Metadata includes details like inclusion status, replication methods, and key properties.

```json
"metadata": [
  {
    "metadata": {
      "inclusion": "available",
      "table-key-properties": ["id"],
      "selected": true,
      "valid-replication-keys": ["date_modified"],
      "schema-name": "users"
    },
    "breadcrumb": []
  },
  {
    "metadata": {
      "inclusion": "automatic"
    },
    "breadcrumb": ["properties", "id"]
  },
  {
    "metadata": {
      "inclusion": "available",
      "selected": true
    },
    "breadcrumb": ["properties", "name"]
  },
  {
    "metadata": {
      "inclusion": "automatic"
    },
    "breadcrumb": ["properties", "updated_at"]
  }
]

```

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

### Meltano Command to Add TAP-GA4 Extractor

Source: https://hub.meltano.com/extractors/tap-ga4

Command to install the TAP-GA4 extractor into a Meltano project. This command assumes Meltano version v3.8+.

```bash
meltano add
              tap-ga4
```

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

### Add tap-metabase extractor in Meltano

Source: https://hub.meltano.com/extractors/tap-metabase

Install the tap-metabase extractor to your Meltano project, enabling data extraction from Metabase. This command is compatible with Meltano 3.8+ and legacy versions. No dependencies beyond Meltano are required.

```bash
meltano add tap-metabase
```

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

### Configure tap-freshdesk settings interactively

Source: https://hub.meltano.com/extractors/tap-freshdesk--airbyte

Command to interactively configure the tap-freshdesk settings in your Meltano project.

```bash
meltano config tap-freshdesk set --interactive
```

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

### List tap-greenhouse Configuration Settings

Source: https://hub.meltano.com/extractors/tap-greenhouse--airbyte

Command to display all configurable settings for the tap-greenhouse extractor. Useful for understanding available options and their current values.

```bash
meltano config tap-greenhouse list
```

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

### Access Token Generation

Source: https://hub.meltano.com/extractors/tap-linkedin-ads--singer-io

Instructions on how to generate an access token for the LinkedIn Ads API, including steps for creating an API app, obtaining client credentials, and authorizing the app.

```APIDOC
## POST /oauth/v2/accessToken

### Description
This endpoint is used to obtain an access token from LinkedIn after authorization.

### Method
POST

### Endpoint
https://www.linkedin.com/oauth/v2/accessToken

### Parameters
#### Request Body
- `grant_type` (string) - Required - The grant type, should be `authorization_code`.
- `code` (string) - Required - The authorization code obtained from the authorization URL.
- `client_id` (string) - Required - Your LinkedIn API application's client ID.
- `client_secret` (string) - Required - Your LinkedIn API application's client secret.
- `state` (string) - Required - A random alphanumeric string used to prevent CSRF.
- `redirect_uri` (string) - Required - The redirect URI configured in your LinkedIn API application.

### Request Example
{
  "grant_type": "authorization_code",
  "code": "YOUR_CODE",
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "state": "YOUR_STATE_KEY",
  "redirect_uri": "YOUR_REDIRECT_URI"
}

### Response
#### Success Response (200)
- `access_token` (string) - The generated access token.

#### Response Example
{
  "access_token": "YOUR_ACCESS_TOKEN"
}
```

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

### List Datahub configuration settings

Source: https://hub.meltano.com/utilities/datahub

Command to display all known settings for the datahub utility. Useful for identifying configurable parameters.

```bash
meltano config datahub list
```

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

### Set tap-mysql Server ID

Source: https://hub.meltano.com/extractors/tap-mysql

This command sets the server ID, which is used as the slave ID when the tap connects to the MySQL server. This is often relevant for replication setups.

```bash
meltano config tap-mysql set server_id [value]

```

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

### Example Singer Record Message Structure

Source: https://hub.meltano.com/singer/spec

Illustrates a complete record message, including type, stream, optional time_extracted, and the actual record data. Record messages represent the data being extracted from a source system.

```json
{
  "type": "RECORD",
  "stream": "tools",
  "time_extracted": "2021-11-20T16:45:33.000Z",
  "record": {
    "id": 1,
    "name": "Meltano",
    "active": true,
    "updated_at": "2021-10-20T16:45:33.000Z"
  }
}
```

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

### Add tap-mongodb Extractor to Meltano Project

Source: https://hub.meltano.com/extractors/tap-mongodb--meltanolabs

This command adds the MongoDB tap-mongodb extractor (meltanolabs variant) to your Meltano project. Ensure you have Meltano version 3.8+ installed.

```bash
meltano add tap-mongodb --variant meltanolabs
```

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

### Test Slack API Access with Curl

Source: https://hub.meltano.com/extractors/tap-slack

Verifies the API key's access to Slack conversations by listing channels. Dependencies: Valid Slack bot token. Inputs: API token via Authorization header. Outputs: JSON response with conversation list. Limitations: Excludes archived channels by default; requires proper scopes like channels:read.

```shell
curl -X GET -H 'Authorization: Bearer <Your Token>' https://slack.com/api/conversations.list?exclude_archived=False

```

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

### Configure tap-zendesk-sell settings interactively via shell

Source: https://hub.meltano.com/extractors/tap-zendesk-sell--airbyte

Interactively sets up configuration settings for tap-zendesk-sell in Meltano. Assumes the extractor is added. Prompts for user inputs during execution, outputs updated configuration. Limitation: Requires an interactive terminal session.

```shell
meltano config tap-zendesk-sell set --interactive

```

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

### Example Singer Schema Message Structure

Source: https://hub.meltano.com/singer/spec

Presents a full schema message, including type, stream, the JSON schema definition, key properties, and optional bookmark properties. Schema messages define the structure of data in record messages.

```json
{
  "type": "SCHEMA",
  "stream": "tools",
  "schema": {
    "properties": {
      "id": {
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "active": {
        "type": "boolean"
      },
      "updated_at": {
        "type": "string",
        "format": "date-time"
      }
    }
  },
  "key_properties": ["id"],
  "bookmark_properties": ["updated_at"]
}
```

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

### Example CSV File Definition Structure

Source: https://hub.meltano.com/extractors/tap-csv--meltanolabs

This JSON structure defines how to map CSV files to entities for the tap-csv extractor. Each object specifies the entity name, the path to the CSV file, and the keys for unique identification.

```json
[
  {
    "entity": "<entity>",
    "path": "<path>",
    "keys": ["<key>"]
  },
  // ...
]
```

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

### Set Criteo Tap Start Date using Meltano CLI

Source: https://hub.meltano.com/extractors/tap-criteo--edgarrmondragon

Command to set the 'start_date' for the tap-criteo extractor. This determines the beginning of the historical data extraction period.

```bash
meltano config tap-criteo set start_date [value]
```

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

### Configure Hub Planner Extractor Settings Interactively in Meltano

Source: https://hub.meltano.com/extractors/tap-hubplanner

Set up configuration for the tap-hubplanner extractor interactively through prompts using the config set command. This allows defining API keys and other parameters step-by-step. Requires the extractor to be added first; inputs are user responses to interactive prompts, and outputs are updated settings or confirmation. Default values may be used if not specified.

```shell
meltano config tap-hubplanner set --interactive
```

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

### Add tap-firebolt Extractor to Meltano Project

Source: https://hub.meltano.com/extractors/tap-firebolt

Installs the tap-firebolt extractor into your Meltano project. This command is compatible with Meltano versions 3.8 and later, as well as legacy versions.

```bash
meltano add tap-firebolt
```

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

### Select Entities and Attributes in meltano.yml

Source: https://hub.meltano.com/extractors/tap-mongodb--meltanolabs

This YAML snippet demonstrates how to select specific entities and attributes for extraction using the tap-mongodb extractor within your `meltano.yml` file. It shows an example of opting out of the `ns` field.

```yaml
select:
  - '!*.ns'
```

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

### S3 JSONL Files Table Configuration

Source: https://hub.meltano.com/extractors/tap-spreadsheets-anywhere

Configures extraction of JSONL records from S3 files matching a prefix pattern. Meltano tap-spreadsheets-anywhere handles the JSON lines as individual records; inputs include bucket path, key properties, and start_date; outputs streamed data. Limitation: Assumes one JSON object per line without nesting.

```yaml
config:
  tables:
  - path: s3://my-bucket-name
    format: json
    key_properties: [user_id]
    name: user_names
    start_date: '2020-01-01T00:00:00Z'
    pattern: my_prefix/user_names.json
```

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

### Test tap-metabase configuration in Meltano

Source: https://hub.meltano.com/extractors/tap-metabase

Validate the tap-metabase extractor settings to confirm they are correct before running pipelines. This command checks connectivity and configuration without extracting data. It assumes prior installation and configuration of the extractor.

```bash
meltano config tap-metabase test
```

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

### Define Prometheus metrics query streams in YAML

Source: https://hub.meltano.com/extractors/tap-prometheus

Configures metric query streams with PromQL expressions, batch processing limits, and step intervals. Defines JSON schema for labels to extract specific dimensions. This example calculates daily online peaks segmented by customer and environment.

```yaml
- name: online_peak
  query: sum(sessions_count)
  batch: '10000'
  step: 120s
  labels:
    type: object
    properties:
      customer:
        type: string
      environment:
        type: string
```

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

### Configure incremental replication in tap-postgres YAML

Source: https://hub.meltano.com/extractors/tap-postgres--meltanolabs

This YAML configuration demonstrates how to set up incremental replication for tap-postgres in a Meltano project. It specifies the extractor details, database connection string, and incremental replication parameters including replication key and primary key properties. Adjust the schema, table names, and connection details to match your PostgreSQL database setup.

```yaml
- name: tap-postgres
  variant: meltanolabs
  pip_url: meltanolabs-tap-postgres
  config:
    sqlalchemy_url: postgresql://meltano_user:password@localhost:5432/my_postgres_db
  select:
  - <my_schema>-<my_table>.*
  metadata:
    <my_schema>-<my_table>:
      replication-method: INCREMENTAL
      replication_key: key
      key_properties:
      - key
```