Getting started

Install in 3 steps

No Docker, no config files to hand-edit. Just install and run.

1

Install with pipx

pipx installs franki in an isolated environment and puts the franki command on your PATH.

# Install pipx if you don't have it
sudo apt install pipx && pipx ensurepath

pipx install franki-cli

Or with pip: pip install franki-cli

2

Run the setup wizard

Adds your AI providers and API keys. Groq and Gemini both have free tiers, so no credit card is needed.

franki init

Running Ollama locally? Choose option 4. No API key is required.

3

Start chatting

franki

Type a message or slash command. Use /help to see everything available.

Reinstall or upgrade

# Upgrade to the latest version
pipx upgrade franki-cli

# Or with pip
pip install -U franki-cli

# Re-run setup if your config is empty after reinstalling
franki init