friendliai/friendlilink

friendliai/friendlilink

Description: For FriendliLink, our integration convenience tool.

Language: TypeScript

License: Apache-2.0

Stars: 7

Forks: 0

Open issues: 0

Created: 2026-09-16T17:11:28Z

Pushed: 2026-09-17T05:41:52Z

Default branch: main

Fork: no

Archived: no

README:

FriendliLink

> Use FriendliAI models in Claude Code, OpenCode, Codex, Pi, Cursor, Hermes Agent, and DeepSeek Harness.

frlink wires the agent's provider settings (API key, base URL, model) to run through FriendliAI, and can restore the original settings just as easily.

Supported agents: Claude Code CLI, Cursor Desktop / IDE, Codex CLI, OpenCode, Pi, Hermes Agent, DeepSeek Harness.

Table of contents

• [Install](#install)
• [Authentication](#authentication)
• [Enabling a harness](#enabling-a-harness)
• [Checking what's installed on your machine](#checking-whats-installed-on-your-machine)
• [Connect a harness](#connect-a-harness)
• [Verify connection](#verify-connection)
• [Restore settings](#restore-settings)
• [Per-harness guides](#claude-code)
• [Claude Code](#claude-code)
• [Cursor](#cursor)
• [Hermes Agent](#hermes-agent)
• [DeepSeek Harness (dsh)](#deepseek-harness-dsh)
• [All commands](#all-commands)

Install

One-liner (downloads and runs the installer):

curl -fsSL https://raw.githubusercontent.com/friendliai/friendlilink/main/install.sh | bash

Or from a clone:

gh repo clone friendliai/friendlilink
cd friendlilink
npm install
npm run dev -- login

The installer builds the CLI and puts a frlink launcher on your PATH (~/.local/bin). Requires Node.js >= 18.

Authentication

Grab your API key at Friendli Suite, then:

frlink login

This saves the key to the OS keychain. If the keychain is unavailable or the write cannot be verified, frlink warns and falls back to ~/.frlink/.api-key with owner-only permissions.

logout removes the key saved by frlink, including the fallback file. It does not disable agents or remove keys already written to their configurations. To disconnect everything, run:

frlink all off
frlink logout

Enabling a harness

Checking what's installed on your machine

frlink check installed

frlink: Installed: Claude Code, Codex, DeepSeek Harness, Hermes Agent, OpenCode, Pi.
frlink: Not installed: Cursor.

Connect a harness

Where ` is one of: claude, cursor, codex, opencode, pi, hermes, dsh`.

frlink on

on configures the agent to use FriendliAI.

To manage all installed agents at once:

frlink all on

frlink: Enabled FriendliAI on Claude Code, Codex, DeepSeek Harness, OpenCode, Pi.
frlink: Cursor is not installed — skipped.
frlink: Hermes Agent is already routed through FriendliAI — left untouched.

Verify connection

frlink status
frlink check status

status shows the agent's current routing status.

FriendliAI API key: saved
claude (Claude Code): routed through FriendliAI
codex (Codex): routed through FriendliAI
cursor (Cursor): routed through FriendliAI
dsh (DeepSeek Harness): routed through FriendliAI
hermes (Hermes Agent): routed through FriendliAI
opencode (OpenCode): routed through FriendliAI
pi (Pi): routed through FriendliAI

Agents frlink has not connected report not routed — they are still on their own provider.

Restore settings

frlink off
frlink all off

off restores the configuration saved before on.

---

Claude Code

Claude Code routes through per-slot model mapping — pick a FriendliAI model for each of Claude Code's model slots, either interactively or with flags:

frlink claude on

claude: routed through FriendliAI.
api key source: keychain
opus: zai-org/GLM-5.3
sonnet: zai-org/GLM-5.3-Flash
haiku: google/gemma-4-31B-it

Cursor

• Launch and quit Cursor once before the first on. Keep it fully closed while its settings are being changed. Commands run from Cursor's terminal are queued until Cursor exits.
• on registers the FriendliAI catalog. Choose a model from each conversation's model picker. Cursor does not accept --model.
• Cursor Cloud Agents—including Build in Cloud, Start from Scratch, Automations, and the Web, iOS, Slack, GitHub, Linear, and API surfaces—cannot use models configured with a custom API key.

Hermes Agent

Hermes resolves its home from $HERMES_HOME (default ~/.hermes), and frlink writes to whatever home that resolves to. To configure frlink per hermes profile, point HERMES_HOME at the profile directory and run on

hermes profile create myprofile # creates ~/.hermes/profiles/myprofile
export HERMES_HOME=~/.hermes/profiles/myprofile
frlink hermes on
hermes -p myprofile # runs against that profile

Run without the env var to configure the default home (~/.hermes).

> Hermes can also be configured without frlink by installing the [hermes-friendli-provider](packages/hermes-friendli-provider/) plugin directly.

DeepSeek Harness (dsh)

dsh operates on a dsh profile (default web). Pass --profile to target a different profile — on every verb (on, off, status), since state is per-profile:

frlink dsh on --profile myprofile

The dsh home itself follows $DSH_HOME (default ~/.dsh).

> DeepSeek Harness can also be configured without frlink by installing the [@friendliai/dsh-llm-friendli](packages/dsh-llm-friendli/) plugin directly.

All commands

frlink — run your coding agents on FriendliAI models

Usage:
frlink [flags]
frlink [flags]

Getting started:
frlink login [--api-key ] Save your FriendliAI API key
frlink check installed [--json] List the agents installed on this machine
frlink all on [flags] Route every installed agent through FriendliAI
frlink all off [flags] Restore every agent's own settings

Agents:
claude Claude Code CLI opencode OpenCode
cursor Cursor Desktop / IDE pi Pi
codex Codex CLI hermes Hermes Agent
dsh DeepSeek Harness

Per-agent commands:
frlink on [--api-key ] [--model ]
frlink off
frlink status [--json]

Agent-specific flags:
claude [--opus|--sonnet|--haiku|--fable|--subagent ]
[--interactive|--non-interactive] [--base-url ]
codex [--reasoning ]
cursor [--force] (takes no --model — you pick the model inside Cursor)
dsh [--profile ]

Flags for `all`:
frlink all on [--api-key ] [--model ] [--base-url ]
[--force]...