WhatsApp-first LLM bot
Project description
faltoobot
faltoobot is a personal assistant that lives on its own WhatsApp account.
How it works
- Get a separate SIM / WhatsApp account for Faltoobot.
- Sign in to that account on a spare phone.
- Install
faltooboton a computer that will stay online. - Run
faltoobot authand scan the QR code from that phone. - Message that WhatsApp number from your own number.
Usage
Install
uv tool install faltoobot
For faster project and code search inside faltoochat, install ripgrep (rg) too:
# macOS
brew install ripgrep
# Ubuntu / Debian
sudo apt-get update && sudo apt-get install -y ripgrep
# Fedora
sudo dnf install ripgrep
# Arch Linux
sudo pacman -S ripgrep
faltoochat falls back without rg, but search is faster and more reliable when it is installed.
Then you can run faltoobot and faltoochat from any folder.
If uv asks you to add its tool bin directory to your PATH, run:
uv tool update-shell
Configure
faltoobot configure
Example ~/.faltoobot/config.toml:
[openai]
api_key = "your_key_here"
oauth = ""
model = "gpt-5.4"
thinking = "high"
fast = false
[bot]
allow_groups = false
allowed_chats = ["15551234567@s.whatsapp.net"]
system_prompt = "You are Faltoobot, a concise and helpful AI assistant replying inside WhatsApp. Keep replies practical and readable on mobile."
If oauth is set, Faltoobot prefers that OAuth auth file over api_key. If oauth is blank, Faltoobot falls back to OPENAI_API_KEY from the environment.
Set allowed_chats to your own WhatsApp JID or phone number to keep the bot private. Leave it empty only if you want Faltoobot to reply to anyone who can message that account.
Pair once
Pair the WhatsApp account once:
faltoobot auth
Sign in to OpenAI Codex
For faltoochat, you can also bootstrap a Codex OAuth login directly. This saves Faltoobot's own auth file under ~/.faltoobot/auth.json by default and writes that path into openai.oauth in your config:
faltoobot login
Run in background
Install Faltoobot as a background service:
faltoobot install
Check whether it is running:
faltoobot status
Watch logs live:
faltoobot logs -f
Notes:
- macOS installs a
launchdagent. - Linux installs a
systemd --userservice. - If you want the Linux service to stay up after logout, enable lingering for your user.
Run in foreground
If you want to run it in the current terminal instead:
faltoobot run
Terminal chat
You can also use Faltoobot locally in the terminal:
faltoochat
faltoochat "draft a release note"
faltoochat --new-session
Commands
On WhatsApp:
/help
/reset
In terminal chat:
/tree
/reset
faltoochat supports image input, queued prompts while answering, and Shift+Enter for multiline input. Paste an image file path or use Ctrl+V to attach the current macOS clipboard image. WhatsApp chats now also support incoming image messages, including captioned images, image-only prompts, and multi-image albums.
Development
Run the Astro docs site locally:
cd website
npm install
npm run dev
Build the static site locally:
cd website
npm run build
Tests
Run the full test suite with coverage:
uv run pytest -n auto --cov=faltoobot --cov-report=term-missing:skip-covered
Coverage is published in the badge above, and pre-commit enforces a minimum of 78% line coverage.
Update
uv tool upgrade faltoobot
Need more details? See the Astro docs site in website/.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file faltoobot-1.5.2.tar.gz.
File metadata
- Download URL: faltoobot-1.5.2.tar.gz
- Upload date:
- Size: 94.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
84a34ad15d4cbd25f26779fbec545408881595aa79f08feea4395da199418373
|
|
| MD5 |
10187bfdd32395bf5ac8db647f466cc8
|
|
| BLAKE2b-256 |
190f15f73ca9bc180373abe7471274b183c6e57a4f1b85f4c4dce85fb205cf84
|
File details
Details for the file faltoobot-1.5.2-py3-none-any.whl.
File metadata
- Download URL: faltoobot-1.5.2-py3-none-any.whl
- Upload date:
- Size: 77.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4a13f1c6ac6cafb5df4590f20d8e9b9a3a90e619fded3c8ea11a1ce0bee4f0ca
|
|
| MD5 |
fba343c28f26cb4ac7aec08a6d45d717
|
|
| BLAKE2b-256 |
65b662ec1442ba5b2e445fb3f46abc08e505c92ee51d0039169202d4cb63f19d
|