Installation

Install the repo as it exists now.

This guide matches the current codebase. It assumes the sibling open_llm_auth workspace is available, because the repo installs it through requirements.txt.

Prerequisites

  • Python 3.11+
  • A working checkout of /mnt/xtra/open_llm_auth/
  • Network access to whichever providers you plan to use through open_llm_auth
  • Optional: Telegram bot token if you want Telegram integration
  • Optional: Qdrant if you want an external vector backend
  • Optional: Twilio credentials if you want the phone bridge
  • Optional: ElevenLabs credentials if you want hosted voice transcription and synthesis

Install from repo

git clone https://github.com/Es00bac/OpenCAS_runtime.git
cd OpenCAS
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
Current repo boundary. There is no packaged PyPI release path documented here. This guide is for the current repository layout.

Recommended configuration path

python -m opencas --tui

The TUI bootstrap is the cleanest way to configure provider material, choose actual discovered chat and embedding models, and set up Telegram.

What you can configure Current support
Provider material mode Copied-local or explicit linked config/env
Chat model Selected from configured discovered models
Embedding model Selected from configured discovered models
Credential import Specific profile ids and environment keys
Telegram Enablement, bot token, DM policy, allowlist
Phone and voice Configured through the dashboard surfaces after launch

Launch

python -m opencas --with-server

The current default address is http://127.0.0.1:8080/dashboard.

Truthful deployment note. OpenCAS keeps its state locally, but normal chat, voice, and embedding calls go through the configured provider lane. It is not accurate to describe the default setup as cloud-free.

Useful overrides: --state-dir, --default-llm-model, --embedding-model-id, --provider-config-path, --provider-env-path, --telegram-enabled.

Troubleshooting

  • If open_llm_auth cannot be imported, confirm the editable dependency path in requirements.txt matches your local checkout.
  • If the dashboard does not load, verify you are opening 127.0.0.1:8080, not the older 8000 default used in stale docs.
  • If the wrong provider or model is active, reopen the TUI bootstrap or inspect the dashboard System tab.