Skip to content

README.md

Latest commit

 

History

History
63 lines (43 loc) · 1.75 KB

README.md

File metadata and controls

63 lines (43 loc) · 1.75 KB

Source Declarative Manifest CLI Usage Guide

This guide explains how to install and use the Source Declarative Manifest (SDM) CLI tool for Airbyte connector development.

Installation

Standard Installation

pipx install airbyte-cdk

If you encounter an error related to a missing distutils module, verify that you are running Python version <=3.11 and try running:

python -m pipx install airbyte-cdk

Using the CLI

The SDM CLI follows standard Airbyte connector command patterns:

source-declarative-manifest [command] --config /path/to/config.json

Where [command] can be:

spec - Show connector specification check - Verify connection to the source discover - List available streams read - Read data from streams

:::caution When developing locally (outside a Docker container), the CLI operates in "remote manifest mode" and expects your manifest to be included in your configuration file. :::

Steps for Local Testing

  1. Convert your manifest from YAML to JSON

Your manifest is defined in YAML, but must be converted to JSON for the config file. You can use an online tool to do so.

Create a config file that includes both your config parameters AND the manifest. Add your entire manifest as a JSON object under the __injected_declarative_manifest key

Example:

{
  "api_key": "very_secret_key",
  "start_time": "04:20",
  "__injected_declarative_manifest": {
    // Insert the JSON version of your manifest here
  }
}
  1. Run the command against your config file
source-declarative-manifest check --config /relative/path/to/config.json
source-declarative-manifest read --config /relative/path/to/config.json --catalog /relative/path/to/catalog.json