docs: reframe README as a software factory and refresh feature media
- Lead with "a software factory, run by a multi-agent orchestrator" and emphasize the plan/build/review/ship assembly-line framing. - Move the Quick start section directly above "The flow". - Re-render the workflow GIFs (Tokyo Night, Shadcn Light, Dark Gray) to pan across the graph nodes with no lingering selection. - Refresh the agent chat GIF. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
136
README.md
@@ -6,7 +6,9 @@
|
||||
|
||||
### From rough idea to production code — automatically.
|
||||
|
||||
**Multi-node agent orchestrator** — tasks, agents, missions, git, files, and worktrees, with any model, local or cloud.
|
||||
### 🏭 A software factory, run by a multi-agent orchestrator.
|
||||
|
||||
Describe what you want — a team of AI agents **plans, builds, reviews, and ships** it for you. Fusion is your software factory: an assembly line for code that runs across tasks, agents, missions, git, files, and worktrees, with any model, local or cloud.
|
||||
|
||||
[**runfusion.ai →**](https://runfusion.ai) · [Docs](./docs/README.md) · [GitHub](https://github.com/Runfusion/Fusion) · [npm](https://www.npmjs.com/package/@runfusion/fusion) · [Discord](https://discord.gg/ksrfuy7WYR)
|
||||
|
||||
@@ -43,6 +45,72 @@ One board. Controlled from anywhere. Laptop, Mac mini, Linux server, cloud VM, p
|
||||
|
||||
---
|
||||
|
||||
## Quick start
|
||||
|
||||
**Zero install, straight from npm:**
|
||||
|
||||
```bash
|
||||
npx runfusion.ai
|
||||
```
|
||||
|
||||
That launches the dashboard. Subcommands forward through: `npx runfusion.ai task create "fix X"`, `npx runfusion.ai --help`, etc. (Or verbosely: `npx @runfusion/fusion dashboard`.)
|
||||
|
||||
**One-line installer** (macOS & Linux — auto-picks Homebrew, falls back to npm):
|
||||
|
||||
```bash
|
||||
curl -fsSL https://runfusion.ai/install.sh | sh
|
||||
fusion dashboard
|
||||
```
|
||||
|
||||
**Homebrew** (macOS & Linux):
|
||||
|
||||
```bash
|
||||
brew tap runfusion/fusion
|
||||
brew install fusion
|
||||
fusion dashboard # or: fn dashboard
|
||||
```
|
||||
|
||||
Or as a one-liner (auto-taps): `brew install runfusion/fusion/fusion`.
|
||||
|
||||
**npm global**:
|
||||
|
||||
```bash
|
||||
npm install -g @runfusion/fusion
|
||||
fn dashboard # or: fusion dashboard
|
||||
```
|
||||
|
||||
**From a clone** (for development):
|
||||
|
||||
```bash
|
||||
pnpm dev dashboard
|
||||
```
|
||||
|
||||
Then click the `Open:` URL printed in the terminal. It embeds a bearer token
|
||||
(`http://localhost:4040/?token=fn_...`) that the browser captures to
|
||||
`localStorage` on first visit and reuses automatically thereafter. On the
|
||||
server side, Fusion now persists the dashboard/daemon token in
|
||||
`~/.fusion/settings.json` on first authenticated run and reuses it on later
|
||||
starts unless you override it (`--token`, `FUSION_DASHBOARD_TOKEN`,
|
||||
`FUSION_DAEMON_TOKEN`) or disable auth with `--no-auth`. See
|
||||
[CLI reference → fn dashboard → Authentication](./docs/cli-reference.md#fn-dashboard)
|
||||
for full precedence and reset/revocation options.
|
||||
|
||||
### First-run setup
|
||||
|
||||
On first launch, Fusion opens the **onboarding wizard** with three guided steps:
|
||||
|
||||
1. **AI Setup** — Use a simplified quick-start provider list (recommended providers plus any already-connected providers), then expand **Advanced provider settings** only if you need additional providers or setup details. You only need one provider to get started. Deprecated Google Gemini CLI / Antigravity provider entries are intentionally hidden; Google/Gemini API key, Google Generative AI, Vertex, and Cloud Code paths remain supported.
|
||||
2. **GitHub (Optional)** — Connect GitHub for issue import and PR management
|
||||
3. **First Task** — Create your first task or import from GitHub (if no project is active, onboarding first prompts you to register/select a project directory)
|
||||
|
||||
The wizard is **dismissible and non-blocking** — click **Skip for now** to use the dashboard immediately. Re-trigger it later from **Settings → Authentication → Reopen onboarding guide**.
|
||||
|
||||
### Mobile
|
||||
|
||||
For Capacitor + PWA workflow, see [MOBILE.md](./MOBILE.md).
|
||||
|
||||
---
|
||||
|
||||
## The flow
|
||||
|
||||
```
|
||||
@@ -347,72 +415,6 @@ npx companies.sh add paperclipai/companies/gstack
|
||||
|
||||
---
|
||||
|
||||
## Quick start
|
||||
|
||||
**Zero install, straight from npm:**
|
||||
|
||||
```bash
|
||||
npx runfusion.ai
|
||||
```
|
||||
|
||||
That launches the dashboard. Subcommands forward through: `npx runfusion.ai task create "fix X"`, `npx runfusion.ai --help`, etc. (Or verbosely: `npx @runfusion/fusion dashboard`.)
|
||||
|
||||
**One-line installer** (macOS & Linux — auto-picks Homebrew, falls back to npm):
|
||||
|
||||
```bash
|
||||
curl -fsSL https://runfusion.ai/install.sh | sh
|
||||
fusion dashboard
|
||||
```
|
||||
|
||||
**Homebrew** (macOS & Linux):
|
||||
|
||||
```bash
|
||||
brew tap runfusion/fusion
|
||||
brew install fusion
|
||||
fusion dashboard # or: fn dashboard
|
||||
```
|
||||
|
||||
Or as a one-liner (auto-taps): `brew install runfusion/fusion/fusion`.
|
||||
|
||||
**npm global**:
|
||||
|
||||
```bash
|
||||
npm install -g @runfusion/fusion
|
||||
fn dashboard # or: fusion dashboard
|
||||
```
|
||||
|
||||
**From a clone** (for development):
|
||||
|
||||
```bash
|
||||
pnpm dev dashboard
|
||||
```
|
||||
|
||||
Then click the `Open:` URL printed in the terminal. It embeds a bearer token
|
||||
(`http://localhost:4040/?token=fn_...`) that the browser captures to
|
||||
`localStorage` on first visit and reuses automatically thereafter. On the
|
||||
server side, Fusion now persists the dashboard/daemon token in
|
||||
`~/.fusion/settings.json` on first authenticated run and reuses it on later
|
||||
starts unless you override it (`--token`, `FUSION_DASHBOARD_TOKEN`,
|
||||
`FUSION_DAEMON_TOKEN`) or disable auth with `--no-auth`. See
|
||||
[CLI reference → fn dashboard → Authentication](./docs/cli-reference.md#fn-dashboard)
|
||||
for full precedence and reset/revocation options.
|
||||
|
||||
### First-run setup
|
||||
|
||||
On first launch, Fusion opens the **onboarding wizard** with three guided steps:
|
||||
|
||||
1. **AI Setup** — Use a simplified quick-start provider list (recommended providers plus any already-connected providers), then expand **Advanced provider settings** only if you need additional providers or setup details. You only need one provider to get started. Deprecated Google Gemini CLI / Antigravity provider entries are intentionally hidden; Google/Gemini API key, Google Generative AI, Vertex, and Cloud Code paths remain supported.
|
||||
2. **GitHub (Optional)** — Connect GitHub for issue import and PR management
|
||||
3. **First Task** — Create your first task or import from GitHub (if no project is active, onboarding first prompts you to register/select a project directory)
|
||||
|
||||
The wizard is **dismissible and non-blocking** — click **Skip for now** to use the dashboard immediately. Re-trigger it later from **Settings → Authentication → Reopen onboarding guide**.
|
||||
|
||||
### Mobile
|
||||
|
||||
For Capacitor + PWA workflow, see [MOBILE.md](./MOBILE.md).
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
|
||||
| Guide | What it covers |
|
||||
|
||||
|
Before Width: | Height: | Size: 1.3 MiB After Width: | Height: | Size: 165 KiB |
|
Before Width: | Height: | Size: 2.4 MiB After Width: | Height: | Size: 250 KiB |
|
Before Width: | Height: | Size: 1.6 MiB After Width: | Height: | Size: 210 KiB |
|
Before Width: | Height: | Size: 2.2 MiB After Width: | Height: | Size: 246 KiB |