gooneyryan/scarf
1
0
Fork 0
mirror of https://github.com/awizemann/scarf.git synced 2026-05-08 02:14:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
Page: First Run
Pages
ACP Subprocess Adding a Feature Module Adding a Service Architecture Overview Build and Run Chat Contributing Core Services Dashboard Data Model Design System First Run Gateway Cron Health Logs Hermes Paths Hermes Version Compatibility Home Insights and Activity Installation Keyboard Shortcuts Localization MCP Servers Plugins Webhooks Tools Memory and Skills Performance Monitoring Platform Differences Platforms Personalities QuickCommands Privacy Policy Project Templates Projects and Profiles Release Notes Index Release Process Roadmap ScarfCore Package ScarfGo Onboarding ScarfGo Roadmap ScarfGo Servers and Remote Sidebar and Navigation Slash Commands Support Template Catalog Template Ideas Test Harness Testing Transport Layer Troubleshooting Slow Chat Startup Uninstalling Updating Wiki Maintenance
Clone
3
First Run
Alan Wizemann edited this page 2026-04-27 13:00:18 +02:00
Table of Contents

First Run

Looking for ScarfGo's first run? The iOS app has a multi-step onboarding flow (host details → SSH key generation → paste public key → connection test). See ScarfGo Onboarding for the walkthrough. This page covers the macOS app.

The first time you launch Scarf, it opens a single window bound to your local Hermes install at ~/.hermes/. That window is automatic — there is no setup screen.

What Scarf expects

For the local server window to work, Hermes must be installed at ~/.hermes/ with at least:

  • ~/.hermes/state.db — SQLite database (created automatically by Hermes on first run).
  • ~/.hermes/config.yaml — runtime config.
  • The hermes CLI on your $PATH (Scarf checks ~/.local/bin/hermes, /opt/homebrew/bin/hermes, /usr/local/bin/hermes, and ~/.hermes/bin/hermes as fallbacks).

If ~/.hermes/ is missing or empty, the Dashboard will tell you so. Install Hermes first per the Hermes README, then relaunch Scarf.

What you'll see

The window opens to the Dashboard — system health, token usage, recent sessions. The sidebar on the left has four groups:

  • Monitor — Dashboard, Insights, Sessions, Activity
  • Interact — Chat, Memory, Skills
  • Configure — Platforms, Personalities, Quick Commands, Credential Pools, Plugins, Webhooks, Profiles, Servers
  • Manage — Tools, MCP Servers, Gateway, Cron, Health, Logs, Settings

Click any item to open it. Selection lives in AppCoordinator — see Sidebar & Navigation for the full list with icons.

Adding a remote server

To open a window against a remote Hermes install, use File → Open Server… → Add Server. You'll need:

  • Hostname or alias (resolved via your ~/.ssh/config)
  • Optional user, port, identity file, remote home, and Hermes binary hint

See Servers & Remote for prerequisites on the remote host (sqlite3, pgrep, SSH key auth, readable ~/.hermes/).

Multiple windows

Each Scarf window is bound to exactly one server. Open as many windows as you want — they run with independent state and can be tiled side-by-side.

ScarfGo on iOS uses a single-window 5-tab layout instead — see Sidebar & Navigation for the cross-platform navigation comparison.

Last updated: 2026-04-25 — Scarf v2.5.0 (cross-linked ScarfGo onboarding + iOS nav)

Getting Started

ScarfGo (iOS)

User Guide

Architecture

Developer Guide

Reference

Troubleshooting

Contributing

Release History

Legal & Support

Wiki edited via the local .wiki-worktree/ clone. See Wiki Maintenance for the workflow. Last sync: 2026-04-20.