Skip to content
fyrn Docs

Quickstart

This guide gets you from zero to a running integration in under 5 minutes.

  1. Install and authenticate

    Terminal window
    npm install -g @fyrn/cli
    fyrn auth login

  2. Initialize a project

    Terminal window
    fyrn init my-integrations && cd my-integrations

  3. Add your connectors

    Terminal window
    fyrn connector add shopify
    fyrn connector add sap-b1

  4. Generate a flow from natural language

    Terminal window
    fyrn generate "Sync new Shopify orders to SAP Business One"

    fyrn generates a YAML flow definition:

    flows/shopify-to-sap-orders.yaml
    name: shopify-to-sap-orders
    trigger:
      connector: shopify
      event: order.created
    steps:
      - transform:
          map:
            order_id: "{{ trigger.id }}"
            customer: "{{ trigger.customer.email }}"
            total: "{{ trigger.total_price }}"
      - deliver:
          connector: sap-b1
          action: sales_order.create
    healing:
      auto_fix: true
      confidence_threshold: 0.95

  5. Test with a dry run

    Terminal window
    fyrn test --dry-run
    # ✓ All validations passed
    # ✓ Connector auth verified: shopify, sap-b1
    # ✓ Mapping valid: 3 fields mapped

  6. Deploy

    Terminal window
    fyrn deploy --env production
    # ✓ Deployed shopify-to-sap-orders v1 to production

That’s it. Your integration is live, processing events in real-time, and self-healing if APIs change.

Check status

Section titled “Check status”
Terminal window
fyrn status --all


# FLOW                     STATUS   HEALTH   MSG/24H
# ───────────────────────────────────────────────────
# shopify-to-sap-orders    active   100%     0

What’s next

Section titled “What’s next”