Installation

Prerequisites

• Node.js 18 or later
• A fyrn account — sign up free

Install the CLI

npm

npm install -g @fyrn/cli

pnpm

pnpm add -g @fyrn/cli

Verify the installation:

fyrn --version

Authenticate

Log in to your fyrn account:

fyrn login

This opens your browser for Auth0 PKCE authentication. On success, credentials are stored in ~/.fyrn/credentials.json.

Check your auth status:

fyrn auth status

CI/CD environments

For headless environments, authenticate with an API key instead:

fyrn auth api-key --api-key sk-your-key --api-url https://api.fyrn.dev

API keys are stored in ~/.fyrn/config.json.

Initialize a project

Create a fyrn project in the current directory:

mkdir my-integrations && cd my-integrations
fyrn init

This creates:

• fyrn.config.json — project configuration (API URL, account ID)
• flows/ — directory for your flow YAML files
• .gitignore entry for fyrn.config.local.json

Set up connectors

Browse the connector catalog to see available integrations:

fyrn connector catalog

Connector instances are configured through the web UI or MCP tools. Each instance stores encrypted credentials and connection settings for a specific system like “my-shopify-store” or “production-sap”.

# List your configured connector instances
fyrn connector instances

# Test a connector's connection
fyrn connector test <instance-id>

fyrn ships with 24 built-in connectors including Shopify, Salesforce, HubSpot, Stripe, Slack, SAP Business One, NetSuite, Jira, QuickBooks, Xero, PostgreSQL, MySQL, and more. You can also build custom connectors from any REST API using fyrn connector build.

IDE integration

fyrn flow files are standard YAML. Any editor with YAML support works well:

• VS Code — install the YAML extension for schema validation and autocomplete
• JetBrains IDEs — built-in YAML support works out of the box

Next steps

• Quickstart — Deploy your first flow in 5 minutes
• Core Concepts — Understand flows, steps, transforms, and connectors
• CLI Usage — Full reference for all CLI commands