Skip to content

Getting started

Upsight is a desktop app for technical CSMs at Kong. It keeps your account data, meeting notes, win wires, and external dashboards in one place, all local and offline-capable, synced to Salesforce on demand.

First launch

The very first time you open the app, it asks for a license key before showing anything else. In practice you only see this screen once. Once a key is accepted, Upsight stores it in config.toml and re-checks it on every launch, so if it still validates you're never asked again. If you use Upsight on more than one Mac or Linux box with the same synced config, activating on one covers the rest (see Multi-machine sync).

If you don't have a key yet, ask whoever administers Upsight for your team to issue you one, then paste it into the activation screen and click Activate.

If the gate reappears on a later launch, your stored key stopped validating, most often because it expired or config.toml got corrupted by a bad sync. Ask your administrator for a new key and activate again; nothing else about your data is affected.

Once past activation, the app opens to the accounts list (Home). On first launch this list is empty. Accounts are pulled from Salesforce the first time you authenticate and run a sync.

Before syncing, you need:

  • The Salesforce CLI (sf) installed and authenticated: sf org login web. The app uses your existing CLI session and never handles your Salesforce credentials directly.
  • An AI binary for AI features: the claude CLI on PATH and logged in. You can skip this and add it later under Settings.

The left sidebar has two levels.

The top section (Home, Action Items, Cases, Feature Requests, Dashboards, Events) is global. These show data across all accounts.

When you select an account from the Home list, the sidebar adds an account-scoped section below the global items. This contains tabs for that account: Overview, Health, People, Action Items, Meetings, Agendas, CX Events, Opportunities, Win Wires, Stack, Usage, Q&A, Documents, and Resources.

Click a different account in the Home list to switch. The account-scoped section updates to reflect the new selection.

A small tools row sits below the main navigation with Sync Log, Events, a theme toggle, Help, and Settings. Help opens an in-app topic browser, separate from this documentation site, useful for a quick reference without leaving the app. On macOS, Settings is reached from the app menu instead (Upsight > Settings…, Cmd+,) and is dropped from this row.

Notifications

The bell icon shows a count of unread alerts: Salesforce sync results, new Aha! comments, an idea shipping, backup results, and similar background events. Click it to open the panel, grouped by source with the newest first.

Click a notification to jump straight to what it's about, an Aha! idea, an account's Health screen, the relevant Settings section, and so on. That also marks it read. Not every notification is clickable; ones without an obvious destination (like a config-level sync failure) just show the alert. Dismiss one notification, a whole source group, or everything at once with Clear all.

See Settings for the toggle that turns desktop notifications on or off.

Keyboard shortcuts

Shortcut Action
Ctrl+1 Home (accounts list)
Ctrl+2 Cases
Ctrl+3 Settings
Ctrl+4 Feature Requests
Ctrl+5 Dashboards
Ctrl+K Command palette (jump anywhere by name)

Density and theme

You can switch between light and dark themes (or follow your system setting) and between comfortable and compact row density in Settings under General.

Checking your setup

Run upsight doctor from a terminal to confirm your integrations and runtime dependencies are wired up correctly: Salesforce auth, Clari, the Google Calendar ICS feed, the win-wire toolchain (pdftotext plus an AI CLI), PDF text extraction for account documents (also pdftotext), the clipboard tool, desktop notifications, the "open in Finder/Explorer" handler, and the claude CLI the Sync Log's "Investigate failure" action needs regardless of your configured AI provider. Each line reports OK (configured and working), SKIP (not configured, not a problem), or FAIL (configured but not working, the only state that fails the command).

Add --ai to also run a real AI generation through your configured binary. It's opt-in because it spends a model call and can take up to 90 seconds, but it's the only check that catches an AI CLI too old for Upsight's flags, an expired login, or a bad [ai] skills path.

Where data lives

Everything is stored in a single SQLite file on your machine. The installed app (Nix-packaged on Linux, or the macOS .dmg release) uses ~/.local/share/upsight/upsight.db by default. Set UPSIGHT_DB before launching to point at a different file. The database isn't encrypted at rest, so consider full-disk encryption on your machine, or point UPSIGHT_DB at an encrypted volume.

See Backup and restore and Multi-machine sync for how to protect and share that file.