OpenCandle GUI Quickstart

1. Start the local GUI with opencandle gui from an installed package, or npm install followed by npm run gui from a source checkout.
2. Open http://127.0.0.1:14567.
3. If the model setup panel appears, connect a model API key first. Chat cannot run without model access. If you want Pi sign-in instead of an API key, complete terminal /setup first and then refresh the GUI.
4. Start with a prompt that needs no API keys, such as What is AAPL trading at? or one of the dashboard suggestion cards. When you want deep research, run /analyze NVDA; the multi-analyst debate takes a few minutes.
5. Open the catalog with ⌘K on macOS, Ctrl+K on Windows/Linux, or the top-bar catalog button. Use Tools to run a single tool, Workflows to submit a workflow prompt, and Providers to inspect missing credentials.
6. Use the composer plus button to attach images or saved context such as your portfolio, watchlist, or latest report before sending a prompt.

The GUI binds to 127.0.0.1:14567 by default. Override with OPENCANDLE_GUI_HOST and OPENCANDLE_GUI_PORT; set OPENCANDLE_GUI_HOST=0.0.0.0 only when you intentionally want LAN or Tailscale access.

You can use the GUI and the equally complete terminal interface on the same session at once; OpenCandle keeps them in sync. If a view says it is reconnecting or syncing, wait a moment and retry.

Check that the server is running:

curl http://127.0.0.1:14567/health

{"ok":true,...} means the server is running; you can ignore the other fields.

The full local-endpoint list is in System Architecture.

Tailscale Access

For remote viewing, keep the local GUI running and expose it with Tailscale Serve from the machine that is running OpenCandle. Use your own Tailscale node address or hostname:

tailscale serve --bg http://127.0.0.1:14567

Get the shared URL with tailscale serve status.

If the page returns 502, the tunnel is up but the local GUI is not listening. Restart npm run gui or opencandle gui and verify curl http://127.0.0.1:14567/health returns {"ok":true,...}.

Market Dashboard, Symbol Pages, and Charts

The home screen is a market dashboard. Below the composer you get an indices strip (S&P 500, Nasdaq Composite, Dow Jones, Bitcoin) with sparklines, top movers from your watchlists, a portfolio summary with the day's move, and an alerts status card. Sending a prompt starts a fresh chat session.

Every ticker links to a symbol page at /symbol/<TICKER>, reachable from watchlist and portfolio rows, ticker popovers in chat, and instrument search. A symbol page shows the live quote with pre-market/after-hours context, an interactive range chart (day through max, with volume, crosshair tooltip, and previous-close line), key stats and fundamentals, plus your saved positions, alerts, and watchlist membership for that symbol.

Charts also appear directly in chat: price-history answers render as interactive chart cards, and comparison prompts render a multi-series chart with each symbol indexed to 100 at the first common date, so relative performance is readable at a glance. Watchlist and portfolio rows carry intraday sparklines with source and freshness context.

Chart and dashboard data is cached locally, so reloading the page or opening a second window stays fast without extra provider calls.

Working In The GUI

The GUI is a local investigation workbench: the transcript, tool catalog, provider setup, and session history stay close together so you can see what evidence the agent is using.

• Ask a normal finance question, such as Should I add NVDA if I already own AAPL and TSLA?
• Launch a workflow from the catalog (Comprehensive Analysis, Compare Assets, Portfolio Builder, Options Screener), or run one tool directly when you only need a quote, option chain, filing lookup, or macro series.
• Open a symbol page for any ticker to see its chart, key stats, and your saved positions and alerts in one place.
• Inspect tool cards to see arguments, results, sources, and warnings.
• Connect provider keys from the Providers tab instead of editing config files.
• Reopen previous sessions and continue the investigation; browser and terminal views of the same session stay in sync.
• Answer focused follow-up questions when OpenCandle needs a ticker, goal, horizon, budget, or risk preference before proceeding.

Workflow catalog entries prefill a structured chat prompt. They do not switch the GUI into a separate mode; the result still appears in the same chat timeline with the same tool cards and session history. Data-quality warnings and provider gaps are available on the Diagnostics page.

Prefer a keyboard-first workflow? The TUI is an equally complete path through the same tools, workflows, evidence, and saved state. See Terminal (TUI). For GUI internals, see System Architecture.