Skip to content

Getting Started

Installation

# pip
pip install salmalm

# pipx (recommended for CLI tools)
pipx install salmalm

# From source
git clone https://github.com/hyunjun6928-netizen/salmalm.git
cd salmalm
pip install -e .

First Launch

salmalm
  1. Setup Wizard — Choose whether to set a master password
  2. Onboarding — Paste your API keys (at least one provider)
  3. Main UI — Start chatting at http://localhost:18800

API Key Setup

You need at least one provider API key:

Provider Get API Key
Anthropic console.anthropic.com
OpenAI platform.openai.com
Google aistudio.google.com
xAI console.x.ai

Local LLM (No API Key Needed)

# Start Ollama
ollama serve
ollama pull llama3.2

# In SalmAlm Settings → Local LLM
# Endpoint: http://localhost:11434/v1

CLI Options

salmalm                    # Default (port 18800)
salmalm --port 9000        # Custom port
salmalm --open             # Auto-open browser
salmalm --shortcut         # Create desktop shortcut
salmalm --update           # Self-update from PyPI

Environment Variables

SALMALM_PORT=18800         # Web server port
SALMALM_BIND=127.0.0.1    # Bind address (0.0.0.0 for LAN)
SALMALM_HOME=~/SalmAlm    # Data directory

Docker

git clone https://github.com/hyunjun6928-netizen/salmalm.git
cd salmalm
docker compose up -d
# → http://localhost:18800

Telegram Bot Setup

  1. Talk to @BotFather → /newbot
  2. Copy bot token
  3. In SalmAlm web UI → Settings → Telegram → Paste token + your chat ID
  4. Restart SalmAlm

Discord Bot Setup

  1. Discord Developer Portal → New Application
  2. Bot → Reset Token → Copy
  3. OAuth2 → bot + applications.commands → Generate URL → Add to server
  4. In SalmAlm web UI → Settings → Discord → Paste token
  5. Restart SalmAlm

Next Steps