Installation

Install the CLI

npm

npm install -g @fyrn/cli

pnpm

pnpm add -g @fyrn/cli

Homebrew

brew tap fyrn/tap
brew install fyrn

Verify the installation:

fyrn --version
# fyrn/0.9.0 linux-x64 node-v20.10.0

Authenticate

Log in to your fyrn account:

fyrn auth login

This opens your browser for OAuth authentication. Once complete, your credentials are stored locally in ~/.fyrn/credentials.json.

Tip

For CI/CD environments, use an API key instead:

export FYRN_API_KEY=your-api-key-here

Initialize a project

Create a new fyrn project directory:

fyrn init my-integrations
cd my-integrations

This creates:

my-integrations/
├── fyrn.config.yaml      # Project configuration
├── flows/                # Your flow definitions
├── connectors/           # Connector configurations
└── .fyrn/                # Local state (gitignored)

Configure connectors

Add the systems you want to integrate:

# Interactive connector setup
fyrn connector add shopify

# Or specify auth directly
fyrn connector add salesforce --auth oauth2

The CLI guides you through authentication for each connector. Credentials are encrypted and stored securely.

Next steps

• Quickstart — Deploy your first flow in 5 minutes
• Your First Flow — Detailed walkthrough of creating a flow
• CLI Reference — Full list of CLI commands