Skip to main content

​
Quick Start Guide

Get Tabby up and running quickly with this streamlined setup guide. This focuses on the essential steps to get you started.
For a complete setup with all features, see the full installation guide.

​
Prerequisites

Before you begin, make sure you have:
1

Install Required Software

2

Get API Keys

At minimum, you need an OpenAI API keyOptional providers:

​
Installation

​
1. Clone and Install

git clone https://github.com/CubeStar1/ai-keyboard.git
cd ai-keyboard

# Install frontend dependencies
cd frontend
pnpm install

# Install Next.js backend dependencies
cd ../nextjs-backend
pnpm install

# Install memory backend dependencies
cd ../backend
uv sync

​
2. Start Supabase

Tabby uses a local Supabase instance via Docker. Make sure Docker Desktop is running first.
# From the project root
npx supabase init    # Only needed the first time
npx supabase start
The first run will download Docker images (~13 images, takes a few minutes). Subsequent starts take ~10 seconds.
After Supabase starts, it will print credentials. Save these - you’ll need:
  • API URL
  • anon key
  • service_role key

​
3. Configure Environment Variables

Create environment files from the examples: 
# Frontend
cp frontend/env.example frontend/.env.local

# Next.js Backend
cp nextjs-backend/env.example nextjs-backend/.env.local

# Memory Backend
cp backend/env.example backend/.env
Edit each file with your credentials: 
# Supabase (from `npx supabase status`)
NEXT_PUBLIC_SUPABASE_URL="http://127.0.0.1:54321"
NEXT_PUBLIC_SUPABASE_ANON_KEY="your-anon-key-here"
SUPABASE_ADMIN="your-service-role-key-here"

NEXT_PUBLIC_APP_NAME="Tabby"
NEXT_PUBLIC_APP_ICON="/logos/tabby-logo.png"

NEXT_PUBLIC_API_URL="http://localhost:3001"
NEXT_PUBLIC_MEMORY_API_URL="http://localhost:8000"

​
4. Create Storage Buckets

You can create buckets via Supabase Studio at http://localhost:54323 → Storage, or use this PowerShell command:
$headers = @{
  "apikey" = "your-service-role-key-here"
  "Authorization" = "Bearer your-service-role-key-here"
  "Content-Type" = "application/json"
}

Invoke-RestMethod -Uri "http://127.0.0.1:54321/storage/v1/bucket" -Method Post -Headers $headers -Body '{"id":"context-captures","name":"context-captures","public":true}'

Invoke-RestMethod -Uri "http://127.0.0.1:54321/storage/v1/bucket" -Method Post -Headers $headers -Body '{"id":"project-assets","name":"project-assets","public":true}'

​
Running Tabby

Start all services in separate terminal windows:
1

Terminal 1: Supabase

npx supabase start
2

Terminal 2: Memory Backend

cd backend
uv run main.py
3

Terminal 3: Next.js Backend

cd nextjs-backend
pnpm dev
4

Terminal 4: Electron App

cd frontend
pnpm dev
The Windows MCP server (Terminal 5: pnpm run windows-mcp) is optional and provides additional desktop automation features.

​
Verify Installation

Once all services are running, you should see:
  • Supabase Studio: http://localhost:54323
  • Frontend: http://localhost:3000
  • Next.js Backend: http://localhost:3001
  • Memory API: http://localhost:8000
  • Tabby App: Running in your system tray

​
First Steps

1

Access the System Tray

Look for the Tabby icon in your system tray. Right-click for options:
  • Show Actions Menu
  • Brain Panel
  • Settings
  • Quit
2

Try the Action Menu

Press Ctrl+\ to open the action menu. Select some text first to see AI actions.
3

Test AI Suggestions

Press Ctrl+Space while typing to get AI suggestions for your current context.
4

Open Brain Panel

Press Ctrl+Shift+B to view the memory dashboard and see stored memories.

​
Essential Keyboard Shortcuts

Get started with these key shortcuts:
ShortcutAction
Ctrl+\Open/close action menu
Ctrl+SpaceGet AI suggestion
Ctrl+Shift+BToggle brain panel
Alt+XAnalyze coding problem (Copilot)
Alt+NGet code suggestions (Copilot)
EscBack/close any panel
See the full keyboard shortcuts reference for all available commands.

​
Troubleshooting

If services fail to start, ensure Docker Desktop is running before starting Supabase.

​
Common Issues

  • Ensure Docker Desktop is running
  • Check if ports 54321-54323 are available
  • Try npx supabase stop then npx supabase start
  • Verify Python 3.12+ is installed
  • Check that uv is installed: pip install uv
  • Ensure the Supabase connection string is correct
  • Verify all environment variables are set
  • Check that ports 3000, 3001, and 8000 are available
  • Try deleting node_modules and running pnpm install again

​
Next Steps

Full Installation

Complete setup with optional features like Neo4j knowledge graphs

Configuration

Configure AI providers, customize shortcuts, and personalize Tabby

Keyboard Shortcuts

Learn all shortcuts to maximize productivity

Interview Copilot

Master the coding interview assistant features

Build docs developers (and LLMs) love

Get started for freeTalk to us