Cannectors Documentation

Cannectors is a cross-platform CLI for running declarative data pipelines. It reads YAML pipeline files and moves records through an input → filters → output flow.

What it does

Pull records from HTTP APIs, SOAP APIs, webhooks, PostgreSQL, MySQL, or SQLite.
Transform records with mapping, condition, script, set, remove, HTTP-call, SOAP-call, and SQL-call filters.
Send records to HTTP APIs, SOAP APIs, or databases.
Handle authentication, retries, scheduling, state persistence, and dry-run previews — all from configuration.

Where to next

Get started

Install Cannectors and run your first pipeline in under 5 minutes.

Concepts

The mental model: pipelines, records, defaults, scheduling, state.

Modules reference

Exhaustive options for every input, filter, and output module.

CLI reference

validate, run, dry-run, flags, exit codes.

Minimal pipeline

name: sync-orders
version: 1.0.0
description: Poll orders from an API and send them as a batch.

input:
  type: httpPolling
  schedule: "*/15 * * * *"
  endpoint: https://source.example.com/api/orders
  dataField: orders

filters:
  - type: mapping
    mappings:
      - source: order_id
        target: id
      - source: customer.email
        target: email

output:
  type: httpRequest
  endpoint: https://destination.example.com/api/orders/import
  method: POST
  requestMode: batch

This documentation site is in active development. Get Started, Concepts, and Modules pages are being written in upcoming phases. See the roadmap.