FRIDAYdocs
GitHub
Introduction

Getting started

Three steps: clone the repo, run one setup script, and start talking. The setup script installs dependencies, the Piper TTS voice, downloads the default models, and bootstraps your .env.

Requirements

  • OS — Ubuntu 22.04+ / Debian 12+ / Kali, or Windows 10 21H2+ / Windows 11.
  • Python — 3.10 to 3.13 (3.11 recommended).
  • RAM — 8 GB minimum, 16 GB recommended.
  • Disk — about 10 GB for models and cache.
  • GPU — optional. llama.cpp and faster-whisper auto-use CUDA when present.

1. Clone & run setup

On Linux:

bash · linux
git clone https://github.com/SanthoshReddy352/Friday_Linux.git
cd Friday_Linux
chmod +x setup.sh
./setup.sh
source .venv/bin/activate
python main.py

On Windows (PowerShell):

powershell · windows
git clone https://github.com/SanthoshReddy352/Friday_Linux.git
cd Friday_Linux
.\setup.ps1
.\.venv\Scripts\Activate.ps1
python main.py
Idempotent setup
The setup scripts skip any step whose output is already on disk, so re-running is safe. A failed or blank model download is reported, not fatal. See Installation for the fully-manual path and troubleshooting.

2. Say your first words

FRIDAY greets you on launch. Trigger it with the wake word or just type in the terminal UI. Try these — each maps to a real capability through the deterministic router:

say to friday
Hey Friday — set brightness to 60.
What's on my calendar today?
Find the file called design final report.
Summarize this PDF.
Take a screenshot and explain it.
What's the weather in Mumbai?
No microphone? No problem.
Launch in text mode with python main.py --text and type your commands. Voice is optional; the whole routing pipeline works the same either way.

3. Choose how you run it

  • python main.py — default terminal UI (voice + text).
  • python main.py --text — force text-only mode.
  • python main.py --gui — the PyQt6 HUD dashboard.
  • python main.py --verbose — debug logging.

Where to go next

← Previous
Overview
Next →
Installation