Documentation

Welcome to Typilot

This quick tour shows where everything lives in the Typilot desktop app so you can feel confident from your very first session.

🧭 Follow each section in order on your first day • No technical background required • You can revisit the tour any time from the Help menu

The Sidebar: Your Command Centre

Dashboard

See this week’s command count, average response speed, favorite shortcuts, and quick tips. Live counters update whenever a command finishes.

Monitoring

Monitor Ollama, the input listener, and the local database in real time. Start, stop, or restart services and review recent alerts when something needs attention.

Models

Browse, download, and remove Ollama models. Progress bars, download speeds, and VRAM usage keep you in control of storage and performance.

Commands

Enable or disable the built-in prompts, create your own 3-letter shortcuts, and reorder your favourites for fast access.

History

Review every AI interaction with timestamps, execution time, status, and model used. Filters and sorting make it easy to find past work.

Logs

Inspect detailed event logs straight from the Tauri backend. Helpful when you are troubleshooting a permission or service issue.

Settings

Adjust keyboard shortcuts, activation behaviour, mouse safe zones, screenshot capture, data retention, and license status in one place.

Help

Open quick references, watch onboarding tips, or jump to the documentation site whenever you need a hand.

Header Controls
Instant Awareness

Start all services

One click spins up Ollama and the keyboard listener together. Typilot shows a loading pulse until everything is ready.

Stop everything safely

Stop all background services before you shut down or change hardware. Confirmation dialogs prevent accidental interruptions.

Model download tray

Watch live progress, speed, and estimated time remaining for large models, and cancel downloads directly from the header.

Light/Dark theme

Switch instantly between bright and dark Aurora themes. Typilot remembers your choice the next time you open the app.

Global shortcut reminder

The header shows the activation shortcut (Ctrl+Space or Cmd+Space by default) so you always know how to summon Typilot.

Quick tips & onboarding

The welcome cards surface context-aware tips, including links to Monitoring or Settings if a service needs set-up.

Workspace Highlights

Typilot is intentionally calm. Subtle animations let you know when something changes without overwhelming your focus.

Smart onboarding

Your first launch opens a guided onboarding sequence that checks Ollama, permissions, and your first model download. You can revisit it later from the Help menu.

Responsive layout

The interface adapts to smaller screens. On laptops, the sidebar collapses to a fly-out menu and the header condenses controls into a compact tray.

Persistent state

Every panel retains filters, sorting, and page size so you resume exactly where you left off—even after restarts.

Keyboard-first navigation

Use Ctrl/Cmd + [1-8] to jump between primary sections, press Esc to close dialogs, and use arrow keys to navigate history details.

First Run Checklist

Complete these steps and you will have Typilot fully operational in under fifteen minutes.

  1. 1. Check system health

    Open Monitoring to confirm Ollama and the input listener show “Online”. Start any offline service with the play button or tap “Retry” on a warning card.

  2. 2. Download a recommended model

    In Models, look for the “Recommended” badge next to llama3.2:3b. Click Download and watch the real-time status tile appear in the header tray.

  3. 3. Try the default commands

    Visit Commands to learn what gen:, exp:, fix:, and img: do. Toggle the examples on to see ready-made prompts and enable the ones you’ll use most.

  4. 4. Run your first request

    Press the activation shortcut in any app, type “gen: write a welcome email”, tap the period key, and watch Typilot stream the reply into your cursor.

  5. 5. Review what happened

    Head to History to see a timestamped record of the request, model, runtime, and response. Open Logs if you want the low-level details.

Badge legend

Green = ready to use, amber = good to review, red = needs action. The same colour rules appear in Monitoring, Models, and Logs.

Need to pause Typilot?

Use the Stop Everything button in the header or disable “Start on startup” inside Settings → System if you only need Typilot occasionally.

Offline by design

All text stays on your computer. As long as Ollama is running, Typilot works with no internet connection—perfect for travel or secure environments.

Ready for more?

Continue with the Getting Started guide for installation steps, or dive into Settings & Preferences if you want to customise shortcuts straight away.

You can always reopen this tour from Help → “App tour” inside Typilot.