Installation¶

Prerequisites¶

Python 3.10 or higher (Python 3.13 recommended)
Node.js (for building the VS Code extension)

Quick Install (pip)¶

pip install sovara

Quick Install (uv)¶

If you use uv for package management, add sovara to your project's dependencies:

uv add sovara

Then run your scripts with:

uv run so-record script.py

Verifying Installation¶

After installation, verify that the CLI commands are available:

so-record --help
so-server --help

Building from Source¶

Create Environment¶

If you're starting from a clean sheet, create a conda environment with the required dependencies:

conda create -n sovara python=3.13 nodejs sqlite -y && conda activate sovara

Install and Build¶

For non-developers, install the project and build the UI:

pip install -e .
cd ui && npm run install:all && npm run build:extension

Running the Extension¶

Open this project in a new VS Code window. Select the "Run Extension" option from the debugger and run it. This will open a new window with the extension enabled.

Launch extension

Try an Example¶

In the new window, you can now open any project that you are working on. For example, run the openai_debate.py example from the example_workflows/debug_examples/ folder:

so-record ./example_workflows/debug_examples/openai_debate.py

Note: This example depends on the OpenAI API. You may need to install it first: pip install openai

Run example

Developer Installation¶

If you are contributing to Sovara, install with development dependencies and set up pre-commit hooks:

pip install -e ".[dev]"
pre-commit install
cd ui && npm run install:all && npm run build:extension