🧰 LobstaKit
Installation

Installation

Three ways to install LobstaKit.


Method 1: pip (Recommended)

pip install lobstakit

For production mode with gunicorn:

pip install lobstakit[prod]

Method 2: curl | bash

curl -fsSL https://get.redlobsta.com/kit | bash

This script downloads LobstaKit, installs it via pip, and runs the initial setup wizard.

Method 3: Docker (Web Dashboard Only)

If you just want the web dashboard without installing Python:

docker run -d \
  --name lobstakit \
  -p 8080:8080 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v ~/.lobsta:/root/.lobsta \
  ghcr.io/0xrichyrich/lobstakit:latest

Then open http://localhost:8080 in your browser.

Verify Installation

lobstakit version
# LobstaKit v0.1.0

Setup Wizard

Run the full installation wizard:

lobstakit install

This walks you through five steps:

Step 1: Checking Prerequisites

LobstaKit checks your system for required software and resources:

CheckWhat It Verifies
curlPresent on the system
gitPresent (optional)
InternetCan reach api.anthropic.com
Disk SpaceAt least 4 GB free
MemoryAt least 2 GB total RAM

Step 2: Docker Setup

LobstaKit checks if Docker is installed, running, and properly configured. If Docker is missing, it will offer to install it automatically using the official install script.

💡

After being added to the docker group, you may need to log out and back in.

Step 3: Configuration

The interactive config wizard runs (same as lobstakit config):

  1. Anthropic API Key — your sk- prefixed key, stored with 0600 permissions
  2. Model Selection — choose between Claude Sonnet 4 (recommended), Opus 4, or Haiku 3.5
  3. Gateway Settings — port for the Lobsta gateway (default: 3000)
  4. Telegram Integration — optional bot token and allowed user IDs
  5. System Settings — timezone and auto-update preferences

Step 4: Download Lobsta

Pulls the Lobsta Docker image from ghcr.io/0xrichyrich/lobsta:latest.

Step 5: Start Lobsta

Starts the Lobsta container using Docker Compose. Your instance is now running!


Configuration Files

All configuration is stored in ~/.lobsta/:

FilePermissionsContents
config.yaml700 (dir)Model, port, timezone, image tag, auto-update, log level
.env600API keys, Telegram tokens
docker-compose.yml700 (dir)Generated Docker Compose config
auth.json600Web dashboard password hash and salt

config.yaml Example

model: claude-sonnet-4-20250514
gateway_port: 3000
gateway_host: 0.0.0.0
image_tag: latest
auto_update: true
timezone: UTC
log_level: info

.env Example

ANTHROPIC_API_KEY=sk-ant-api03-...
MODEL=claude-sonnet-4-20250514
GATEWAY_PORT=3000
GATEWAY_HOST=0.0.0.0
TELEGRAM_BOT_TOKEN=1234567890:ABCdefGHIjklMNOpqrstUVWxyz
TELEGRAM_ALLOWED_USERS=12345678,87654321
TZ=UTC
LOG_LEVEL=info