Skip to main content
Before setting up Tabby AI Keyboard, ensure you have the following tools and accounts ready.

Required Software

1

Node.js 18+

Download and install from nodejs.org
2

Python 3.12+

Required for the memory backend. Download from python.org
3

uv (Python package manager)

Install from astral-sh/uv
# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
4

pnpm

Install the fast, disk space efficient package manager:
npm install -g pnpm
5

Docker Desktop

Required for running local Supabase. Download from docker.com/products/docker-desktop
Make sure Docker Desktop is running before starting Supabase

Required API Keys

1

OpenAI API Key

Create an account and get your API key from platform.openai.com
This is required for the AI features to work
2

Tavily API Key (Web Search)

Sign up at tavily.ai for web search capabilities

Optional API Keys

These providers can be used as alternatives or supplements to OpenAI:
  • Google Generative AI - Get your key from ai.google.dev
  • XAI - API key from XAI platform
  • Groq - Fast inference at groq.com
  • Cerebras - High-performance inference
  • OpenRouter - Access multiple models through one API at openrouter.ai

Optional Services

Neo4j (Knowledge Graph)

For advanced knowledge graph features, you can set up a Neo4j instance. See the Neo4j setup guide for details.
The knowledge graph is completely optional. Tabby works perfectly fine without it.

Next Steps

Once you have all prerequisites installed, proceed to:
  1. Clone the repository and install dependencies
  2. Set up the local database
  3. Configure environment variables

Build docs developers (and LLMs) love