Files
fusion/docs/getting-started.md
Fusion 269b13ecb1 feat(FN-2481): align Hermes runtime artifacts and compatibility coverage
- Regenerate fusion-plugin-hermes-runtime build artifacts and manifest metadata for runtime packaging
- Refactor Hermes runtime source into dedicated pi-module, runtime-adapter, and shared type modules
- Expand Hermes and engine plugin-runner tests to validate cross-runtime compatibility behavior
- Update getting-started, settings reference, and Hermes README docs to reflect the current runtime integration guidance
2026-04-24 14:44:04 -07:00

8.1 KiB
Raw Blame History

Getting Started

← Docs index

This guide gets Fusion running, explains first-run setup, and walks through your first task from creation to completion.

Prerequisites

Fusion uses the pi agent runtime for AI sessions.

  1. Install pi:
npm i -g @mariozechner/pi-coding-agent
  1. Authenticate pi (for example with /login) or configure provider API keys.
pi

Optional: Install the Paperclip Runtime Plugin

The Paperclip Runtime Plugin (fusion-plugin-paperclip-runtime) provides an alternative runtime adapter for AI agents. It wraps the same pi backend but registers as a discoverable plugin runtime, enabling runtime selection at the agent level.

To install the plugin:

fn plugin add ./plugins/fusion-plugin-paperclip-runtime

After installation, select the Paperclip runtime for an agent by setting runtimeHint in the agent's runtimeConfig:

{
  "name": "Paperclip Executor",
  "role": "executor",
  "runtimeConfig": {
    "runtimeHint": "paperclip"
  }
}

For details on runtime selection, fallback behavior, and constraints, see the Paperclip Runtime Plugin documentation.

Optional: Install the Hermes Runtime Plugin (Experimental)

The Hermes Runtime Plugin (fusion-plugin-hermes-runtime) registers an experimental runtime hint ("hermes") so agents can explicitly target Hermes in runtime selection.

Install the plugin:

fn plugin add ./plugins/fusion-plugin-hermes-runtime

Configure an agent to use Hermes:

{
  "name": "Hermes Executor",
  "role": "executor",
  "runtimeConfig": {
    "runtimeHint": "hermes"
  }
}

Hermes is experimental. Runtime registration, selection, and execution are supported through the Hermes plugin runtime adapter.

For Hermes-specific details, see the Hermes Runtime Plugin documentation.

Optional: Install the OpenClaw Runtime Plugin (Experimental)

The OpenClaw Runtime Plugin (fusion-plugin-openclaw-runtime) registers an experimental runtime hint ("openclaw") so agents can explicitly target OpenClaw in runtime selection.

Install the plugin:

fn plugin add ./plugins/fusion-plugin-openclaw-runtime

Configure an agent to use OpenClaw:

{
  "name": "OpenClaw Executor",
  "role": "executor",
  "runtimeConfig": {
    "runtimeHint": "openclaw"
  }
}

OpenClaw is experimental. Runtime registration, selection, and execution are supported through the OpenClaw plugin runtime adapter.

For OpenClaw-specific details, see the OpenClaw Runtime Plugin documentation.

Install Fusion

Install the published CLI package globally:

npm i -g @runfusion/fusion

Then verify install:

fn --help

Initialize a Project

In each repository you want Fusion to manage, run:

fn init

On fresh init, Fusion also installs its bundled fusion skill into supported agent homes (~/.claude/skills/fusion, ~/.codex/skills/fusion, ~/.gemini/skills/fusion) when those targets are missing. Existing installs are left untouched.

First Run and Onboarding

Start the dashboard:

fn dashboard

On first launch, Fusion automatically opens the onboarding wizard. It guides you through three steps:

  1. AI Setup — Connect an AI provider and choose a default model. Authenticate via OAuth login (for supported providers like OpenAI Codex) or enter an API key directly.

  2. GitHub (Optional) — Connect GitHub to import issues and manage pull requests. This step is optional — you can continue without GitHub.

  3. First Task — Get started by creating your first task or importing from GitHub. If no project is currently selected, onboarding first prompts you to register/select a project directory before task actions are enabled.

The onboarding wizard is dismissible and non-blocking. If you skip setup, you can complete it later — and you can always update your AI provider authentication anytime via Settings → Authentication in the dashboard:

  • Click Skip for now to dismiss the wizard — the dashboard remains fully usable
  • After dismissing, a Continue Setup banner appears at the top of the dashboard, letting you resume from where you left off
  • Re-open onboarding anytime from Settings → Authentication → Reopen onboarding guide

When reopening onboarding, the wizard pre-populates your previously saved AI provider and default model, so you can quickly review or update your setup.

Onboarding completion is tracked by modelOnboardingComplete in global settings.

Start the Dashboard

Common startup options:

fn dashboard                       # default port 4040
fn dashboard --port 5050           # custom port
fn dashboard -p 5050               # short form for --port
fn dashboard --interactive         # choose port interactively
fn dashboard --paused              # start with automation paused
fn dashboard --dev                 # run UI only (no engine)

On startup, Fusion prints a click-to-open URL that includes a bearer token:

→ http://localhost:4040
Token:   fn_8f3a...
Open:    http://localhost:4040/?token=fn_8f3a...

Click the Open link. Your browser captures the token into localStorage, strips it from the visible URL, and reuses it automatically on later loads. See CLI reference → fn dashboard → Authentication for details, including token precedence (CLI/env overrides over the persisted ~/.fusion token) and how to disable auth with --no-auth for strictly-local setups.

Other launch modes:

fn dashboard --host 0.0.0.0            # expose on LAN (auth stays on by default)
fn serve --port 5050 --host 0.0.0.0    # headless node (API + engine, no web UI)
fn daemon --port 5050                  # daemon mode with token auth support
fn desktop                             # launch Electron desktop app

Create Your First Task

You can create tasks from the board or CLI.

Option A: Quick Entry (Board)

  1. Type a short request in the quick entry input.
  2. Press Enter.
  3. Task appears in Triage and the triage agent generates PROMPT.md.

Option B: Plan Mode (Board)

Use the 💡 button to open AI planning mode:

  • Fusion asks clarifying questions
  • Produces a structured summary
  • Lets you create one task or break into multiple dependency-linked tasks

Option C: Subtask Breakdown (Board)

Use the 🌳 button to:

  • Generate 25 subtasks
  • Reorder by drag-and-drop
  • Add dependency links before creating tasks

Option D: Expanded Controls (Board)

Expand the quick entry panel (▼) to access additional controls:

  • Refine () — Improve the description with AI
  • Deps (🔗) — Link existing tasks as dependencies
  • Attach — Add image attachments
  • Models (🧠) — Set per-task model overrides
  • Agent — Assign an agent to the task
  • Save — Create the task manually

Option E: CLI

fn task create "Fix flaky login test"
fn task plan "Implement role-based access control"

Understand the Task Lifecycle

Fusion uses six columns:

  1. Triage — raw idea; AI writes spec
  2. Todo — specified and queued
  3. In Progress — executor implements in a dedicated worktree
  4. In Review — implementation complete, awaiting merge/finalization
  5. Done — merged and complete
  6. Archived — retained for history, optionally cleaned up from filesystem

Daily CLI Commands

fn task list
fn task show FN-001
fn task logs FN-001 --follow --limit 50
fn task steer FN-001 "Prefer existing utility functions"
fn task pause FN-001
fn task unpause FN-001

Dashboard Orientation (Annotated)

Dashboard board view with key UI areas

Suggested way to read the screen:

  • Top bar: global actions (settings, activity, mission/agent tools)
  • Columns: task lifecycle stages
  • Task cards: status, metadata, PR/issue badges
  • Quick entry: fastest way to create a new task

Next: Architecture for internals, or Task Management for deeper task workflows.