feat(FN-3309): remove PI install references and documentation
Merges the final step for FN-3309, adding a changeset to document the removal of pi install references. The changeset is the only file changed, completing the feature work. Fusion-Task-Id: FN-3309
This commit is contained in:
Fusion
5
.changeset/fn-3309-remove-pi-install-refs.md
Normal file
5
.changeset/fn-3309-remove-pi-install-refs.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@runfusion/fusion": patch
|
||||
---
|
||||
|
||||
Remove "install pi" references from user-facing docs and skill files. Fusion no longer requires pi as a prerequisite — all pi installation instructions and "pi extension" framing have been removed from README, docs, and AI skill files.
|
||||
36
README.md
36
README.md
@@ -37,7 +37,7 @@ Describe a task in plain language. A planning agent reads your project, understa
|
||||
|
||||
One board. Controlled from anywhere. Laptop, Mac mini, Linux server, cloud VM, phone — all connected.
|
||||
|
||||
> Like Trello, but your tasks get specified, executed, and delivered by AI — powered by [pi](https://github.com/badlogic/pi-mono). Built on the great work of [dustinbyrne/kb](https://github.com/dustinbyrne/kb).
|
||||
> Like Trello, but your tasks get specified, executed, and delivered by AI. Built on the great work of [dustinbyrne/kb](https://github.com/dustinbyrne/kb).
|
||||
|
||||
---
|
||||
|
||||
@@ -71,7 +71,7 @@ Every task shows its plan, its reviews, its diffs, and its file changes in real
|
||||
| 🌳 **Worktree isolation** | Each task runs in its own branch and worktree (`fusion/{task-id}`). Parallel tasks. Zero conflicts. |
|
||||
| ⚡ **Smart merge** | Passing every gate? Fusion squash-merges and moves on. Opt into manual approval anywhere. |
|
||||
| 🛰️ **Multi-node mesh** | Laptop, Mac mini, Linux server, cloud VM, phone — all synced. Desktop, mobile, web. |
|
||||
| 🧩 **Any model** | Anthropic, OpenAI, Ollama — or anything pi-compatible. Local and cloud coexist. |
|
||||
| 🧩 **Any model** | Anthropic, OpenAI, Ollama, and more. Local and cloud coexist. |
|
||||
| 🏢 **Agent companies** | Import pre-built teams — 440+ agents across 16 companies — and run them autonomously for weeks. |
|
||||
| 📬 **Inter-agent messaging** | Built-in mailbox between agents. Delegate, clarify, coordinate. |
|
||||
| 🗺️ **Missions** | Hierarchical planning (Mission → Milestone → Slice → Feature → Task) with autopilot and validation contracts. |
|
||||
@@ -142,7 +142,7 @@ Laptop, Mac mini, Linux server, cloud VM, phone — every node is a peer. Your t
|
||||
- 🖥️ **Desktop app** — Electron for **macOS** (Intel + Apple Silicon), **Windows** 10/11, and **Linux**
|
||||
- 📱 **Mobile app** — Capacitor for **iOS/iPadOS** and **Android** ([MOBILE.md](./MOBILE.md))
|
||||
- 🌐 **Web dashboard** — any modern browser, served from the `fn dashboard` daemon
|
||||
- 🔌 **CLI** — `fn` binary + pi extension for terminal-first workflows
|
||||
- 🔌 **CLI** — `fn` binary + extension for terminal-first workflows
|
||||
|
||||
Start the daemon on any node, connect your other devices, and the board follows you everywhere.
|
||||
|
||||
@@ -164,27 +164,9 @@ npx companies.sh add paperclipai/companies/gstack
|
||||
|
||||
---
|
||||
|
||||
## Built on Pi. Compatible with the tools you already use.
|
||||
## Compatible with the tools you already use.
|
||||
|
||||
Fusion stands on open tools we love. Every **Pi** extension works out of the box. **Hermes**, **Paperclip**, and **OpenClaw** all ship as first-class plugins — route any workspace to whichever runtime fits the task. And any Paperclip agent-company imports with a single command.
|
||||
|
||||
<div align="center">
|
||||
<img src="./demo/assets/pi-logo.svg" alt="Pi" height="56" />
|
||||
</div>
|
||||
|
||||
### [Pi](https://pi.dev) — the runtime
|
||||
|
||||
<sub>pi.dev</sub>
|
||||
|
||||
Fusion is built on top of **Pi** — the minimal, extensible coding-agent CLI. Every [Pi extension](https://github.com/badlogic/pi-mono#extensions) works inside of Fusion. Install Fusion as a Pi extension to get native tools (`fn_task_create`, `fn_task_list`, `fn_task_show`, …) and a `/fn` command to manage Fusion from any Pi session.
|
||||
|
||||
```bash
|
||||
pi install npm:@runfusion/fusion
|
||||
```
|
||||
|
||||
> This installs the **Pi extension** — it provides Fusion tools and `/fn` inside pi sessions only. To get the `fn` CLI in your terminal, install globally: `npm install -g @runfusion/fusion`.
|
||||
|
||||
<br />
|
||||
Fusion integrates with the tools you love. **Hermes**, **Paperclip**, and **OpenClaw** all ship as first-class plugins — route any workspace to whichever runtime fits the task. And any Paperclip agent-company imports with a single command.
|
||||
|
||||
<div align="center">
|
||||
<img src="./demo/assets/hermes-logo.svg" alt="Hermes" height="56" />
|
||||
@@ -220,7 +202,7 @@ npx companies.sh add paperclipai/companies/gstack
|
||||
|
||||
<br />
|
||||
|
||||
> **Hermes**, **Paperclip**, and **OpenClaw** are **experimental** runtime plugins — APIs and wire formats may shift between minor releases. **Pi** is Fusion's stable runtime dependency.
|
||||
> **Hermes**, **Paperclip**, and **OpenClaw** are **experimental** runtime plugins — APIs and wire formats may shift between minor releases.
|
||||
|
||||
---
|
||||
|
||||
@@ -258,8 +240,6 @@ npm install -g @runfusion/fusion
|
||||
fn dashboard # or: fusion dashboard
|
||||
```
|
||||
|
||||
> **Pi extension (optional):** To use Fusion tools inside Pi chat sessions, also run `pi install npm:@runfusion/fusion`. This adds a `/fn` command and Fusion tools within pi — but does not install the `fn` CLI globally.
|
||||
|
||||
**From a clone** (for development):
|
||||
|
||||
```bash
|
||||
@@ -328,7 +308,7 @@ Fusion supports OAuth-based authentication for AI providers configured via **Set
|
||||
- **OpenAI Codex** — Authenticates via Settings OAuth flow with secure state validation
|
||||
- **Factory AI — via Droid CLI** *(optional)* — requires local `droid` install + `droid auth login`, then enable the provider in **Settings → Authentication** and restart Fusion
|
||||
- **Other providers** — Authenticate via API key entry in Settings (including Google/Gemini API key, Google Generative AI, Vertex, and Cloud Code aliases)
|
||||
- **pi authentication** — Handled separately via the `pi` CLI (`/login`) or `ANTHROPIC_API_KEY` environment variable
|
||||
- **Anthropic** — Authenticate via `ANTHROPIC_API_KEY` environment variable
|
||||
|
||||
### Model system
|
||||
|
||||
@@ -438,7 +418,7 @@ fn skills install firebase/agent-skills # Install agent skills
|
||||
| `@fusion/core` | Domain model — tasks, board columns, SQLite store |
|
||||
| `@fusion/dashboard` | Web UI — Express server + kanban board with SSE |
|
||||
| `@fusion/engine` | AI engine — planning, execution, scheduling, workflow steps |
|
||||
| `@runfusion/fusion` | CLI + pi extension — published to npm |
|
||||
| `@runfusion/fusion` | CLI + extension — published to npm |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -54,8 +54,6 @@ fn --help
|
||||
fusion --help
|
||||
```
|
||||
|
||||
> **Optional — Pi extension:** To use Fusion tools inside [Pi](https://pi.dev) chat sessions, run `pi install npm:@runfusion/fusion`. This adds a `/fn` command and Fusion tools within pi. You do **not** need this to use Fusion — the global CLI and dashboard work standalone.
|
||||
|
||||
## Initialize a Project
|
||||
|
||||
In each repository you want Fusion to manage, run:
|
||||
|
||||
@@ -50,24 +50,8 @@ npm install -g @runfusion/fusion
|
||||
fn dashboard # or: fusion dashboard
|
||||
```
|
||||
|
||||
As a [pi](https://github.com/badlogic/pi-mono) extension (bundled skill + `/fn` command):
|
||||
|
||||
```bash
|
||||
pi install npm:@runfusion/fusion
|
||||
```
|
||||
|
||||
If your local Pi install gets stale or broken, open Fusion dashboard **Settings → Pi Extensions** and use **Reinstall Fusion skill** to reinstall `npm:@runfusion/fusion` and refresh discovered extensions.
|
||||
|
||||
## Launch the dashboard
|
||||
|
||||
Inside a pi session:
|
||||
|
||||
```
|
||||
/fn # start on default port 4040
|
||||
/fn stop # stop it
|
||||
/fn 8080 # run on a custom port
|
||||
```
|
||||
|
||||
From a shell:
|
||||
|
||||
```bash
|
||||
@@ -145,7 +129,7 @@ This execution model is heavily based on [Taskplane](https://www.npmjs.com/packa
|
||||
| 🌳 **Worktree isolation** | Each task runs in its own branch and worktree. Parallel tasks. Zero conflicts. |
|
||||
| ⚡ **Smart merge** | Passing every gate? Fusion squash-merges and moves on. |
|
||||
| 🛰️ **Multi-node mesh** | Laptop, server, cloud, phone — all synced. Desktop, mobile, web. |
|
||||
| 🧩 **Any model** | Anthropic, OpenAI, Ollama — or anything pi-compatible. |
|
||||
| 🧩 **Any model** | Anthropic, OpenAI, Ollama, and more. |
|
||||
| 🏢 **Agent companies** | Import pre-built teams — 440+ agents across 16 companies. |
|
||||
| 📬 **Inter-agent messaging** | Built-in mailbox between agents. Delegate, clarify, coordinate. |
|
||||
| 🗺️ **Missions** | Hierarchical planning with autopilot and validation contracts. |
|
||||
@@ -169,13 +153,13 @@ Manage tasks without leaving the conversation:
|
||||
|
||||
> "Pause FN-012 — I want to add more context first"
|
||||
|
||||
The pi extension exposes tools to create tasks, check progress, attach files, and pause or resume automation.
|
||||
The Fusion extension exposes tools to create tasks, check progress, attach files, and pause or resume automation.
|
||||
|
||||
---
|
||||
|
||||
## Standalone CLI
|
||||
|
||||
Fusion also works as a standalone CLI outside of pi. See [STANDALONE.md](./STANDALONE.md) for installation and usage without the pi extension.
|
||||
See [STANDALONE.md](./STANDALONE.md) for additional installation and usage options.
|
||||
|
||||
## Optional provider: Factory AI via Droid CLI
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Fusion is an AI-orchestrated task board. You throw in rough ideas; AI specifies,
|
||||
**Missions** provide hierarchical planning above tasks:
|
||||
Mission → Milestone → Slice → Feature → Task
|
||||
|
||||
**Available tools:** Fusion registers tools via the pi extension (prefixed `fn_*`). No CLI commands or Bash needed — use the registered tools directly.
|
||||
**Available tools:** Fusion registers tools (prefixed `fn_*`). No CLI commands or Bash needed — use the registered tools directly.
|
||||
|
||||
**Naming boundary:** The published pi-extension skill surface uses `fn_*` tool names (for example `fn_task_create`, `fn_mission_create`). Engine runtime sessions also inject additional `fn_*` tools (for example `fn_review_spec`, `fn_review_step`, `fn_spawn_agent`) that are not user-invokable extension tools.
|
||||
**Naming boundary:** The published skill surface uses `fn_*` tool names (for example `fn_task_create`, `fn_mission_create`). Engine runtime sessions also inject additional `fn_*` tools (for example `fn_review_spec`, `fn_review_step`, `fn_spawn_agent`) that are not part of the published skill surface.
|
||||
|
||||
**Engine runtime tools:** Triage/executor/merger/heartbeat sessions include auto-injected engine tools that do not come from the pi extension registration list. See `references/engine-tools.md` for the canonical runtime-only catalog and usage boundaries.
|
||||
**Engine runtime tools:** Triage/executor/merger/heartbeat sessions include auto-injected engine tools that are not part of the published skill surface. See `references/engine-tools.md` for the canonical runtime-only catalog and usage boundaries.
|
||||
|
||||
**Tool categories:**
|
||||
<!-- BEGIN: tool-categories (auto-generated by scripts/sync-fusion-skill-tools.mjs — do not edit by hand) -->
|
||||
@@ -85,7 +85,7 @@ Use `fn_mission_create` for high-level objectives, then add milestones, slices,
|
||||
|
||||
<known_limitations>
|
||||
|
||||
These operations are **not available** via pi extension tools and require the dashboard or CLI:
|
||||
These operations are **not available** via extension tools and require the dashboard or CLI:
|
||||
|
||||
- **Moving tasks between columns** — No tool for column moves (handled by the AI engine)
|
||||
- **Workflow steps** — Creating/managing workflow step definitions requires the dashboard
|
||||
@@ -103,7 +103,7 @@ For these operations, guide the user to the dashboard (`/fn`) or CLI commands do
|
||||
|-----------|-------------|
|
||||
| references/cli-commands.md | Full CLI command reference |
|
||||
| references/task-structure.md | Task file structure and storage |
|
||||
| references/extension-tools.md | All pi extension tools with parameters |
|
||||
| references/extension-tools.md | All extension tools with parameters |
|
||||
| references/best-practices.md | Tips for effective Fusion usage |
|
||||
| references/fusion-capabilities.md | Complete feature catalog |
|
||||
| references/engine-tools.md | Engine session-scoped runtime tools (not extension-invokable) |
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# Engine Session-Scoped Tools
|
||||
|
||||
These tools are **not** part of the pi extension's user-invokable `extension.ts` surface. They are injected by the engine at runtime for specific agent session types.
|
||||
These tools are **not** part of the user-invokable extension surface. They are injected by the engine at runtime for specific agent session types.
|
||||
|
||||
- Source files: `packages/engine/src/agent-tools.ts`, `triage.ts`, `executor.ts`, `merger.ts`, `agent-heartbeat.ts`
|
||||
- Availability: only when the engine creates a session for the matching agent role
|
||||
- Important: do not tell users to call these directly from the generic pi extension tool list
|
||||
- Important: do not tell users to call these directly from the generic extension tool list
|
||||
|
||||
## Shared runtime tools (`agent-tools.ts`)
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Fusion Pi Extension Tools
|
||||
# Fusion Extension Tools
|
||||
|
||||
All tools are registered via the pi extension. They are available in any pi agent session when the Fusion extension is installed.
|
||||
All tools are registered via the Fusion extension. They are available in any agent session when Fusion is configured.
|
||||
|
||||
> Naming contract: all externally exposed Fusion extension tools are `fn_*` (for example `fn_task_create`). Engine runtime sessions also inject additional `fn_*` tools (for example `fn_review_step`, `fn_spawn_agent`, `fn_task_document_write`) that are separate from this extension surface and documented in `engine-tools.md`.
|
||||
|
||||
@@ -364,7 +364,7 @@ Cancel a research run.
|
||||
|
||||
### /fn
|
||||
|
||||
Start or stop the Fusion dashboard from within a pi session.
|
||||
Start or stop the Fusion dashboard from within an agent session.
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
Fusion is an AI-orchestrated task board. Tasks flow through columns:
|
||||
Triage → Todo → In Progress → In Review → Done → Archived
|
||||
|
||||
## Pi Extension Tools (Available to Agents)
|
||||
## Extension Tools (Available to Agents)
|
||||
|
||||
All skill/extension tool invocations in this catalog use the public `fn_*` namespace. Engine runtime sessions also have additional runtime-only `fn_*` tools that are intentionally not listed here (see `references/engine-tools.md`).
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
## Key Takeaways for Fusion Skill
|
||||
|
||||
1. **Use router pattern** — Fusion has multiple distinct workflows (task management, lifecycle, specs, dashboard/CLI)
|
||||
2. **No `allowed-tools` needed** — Fusion tools are registered via pi extension, not Bash CLI
|
||||
2. **No `allowed-tools` needed** — Fusion tools are registered via the extension, not Bash CLI
|
||||
3. **Inline essential concepts** — Task columns, workflow overview in SKILL.md
|
||||
4. **Progressive disclosure** — SKILL.md routes to workflows, workflows reference detailed docs
|
||||
5. **Pure XML structure** — No markdown headings (#, ##, ###) in body
|
||||
|
||||
@@ -3,14 +3,14 @@
|
||||
</required_reading>
|
||||
|
||||
<objective>
|
||||
Guide the agent through using the Fusion dashboard and CLI for operations not available via pi extension tools.
|
||||
Guide the agent through using the Fusion dashboard and CLI for operations not available via extension tools.
|
||||
</objective>
|
||||
|
||||
<process>
|
||||
|
||||
**Starting the dashboard:**
|
||||
|
||||
Use the `/fn` command (registered by the pi extension):
|
||||
Use the `/fn` command (registered by the Fusion extension):
|
||||
- `/fn` or `/fn 4040` — Start dashboard + AI engine on specified port (default 4040)
|
||||
- `/fn stop` — Stop the dashboard
|
||||
- `/fn status` — Check if dashboard is running
|
||||
@@ -28,7 +28,7 @@ The dashboard provides:
|
||||
|
||||
**Operations that require CLI or dashboard:**
|
||||
|
||||
These cannot be done with pi extension tools:
|
||||
These cannot be done with extension tools:
|
||||
|
||||
| Operation | CLI Command | Dashboard |
|
||||
|-----------|-------------|-----------|
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
</required_reading>
|
||||
|
||||
<objective>
|
||||
Guide the agent through creating, viewing, and managing tasks on the Fusion board using pi extension tools.
|
||||
Guide the agent through creating, viewing, and managing tasks on the Fusion board using extension tools.
|
||||
|
||||
Use only the public `fn_*` extension tools in this workflow. Do not substitute internal engine runtime tools like `task_create`, `task_update`, `task_log`, or `task_done`.
|
||||
</objective>
|
||||
|
||||
@@ -708,7 +708,7 @@ export default function kbExtension(pi: ExtensionAPI) {
|
||||
await store.moveTask(params.id, 'todo');
|
||||
|
||||
// Log the retry action
|
||||
await store.logEntry(params.id, "Retry requested via Pi extension", "Task reset to todo for retry");
|
||||
await store.logEntry(params.id, "Retry requested via Fusion extension", "Task reset to todo for retry");
|
||||
|
||||
return {
|
||||
content: [{ type: "text", text: `Retried ${params.id} → todo (failure state cleared)` }],
|
||||
|
||||
Reference in New Issue
Block a user