#Installation Guide
This guide will walk you through the process of installing Theseus on your system.
##Prerequisites
Before installing Theseus, ensure you have the following prerequisites:
node.js
andnpm
pipx
- If you don't have this installed, visit pipx installation guide- API Key (just one is required):
Note: Windows support is currently in development. We welcome contributions to help improve Windows compatibility!
##Installation Steps
###1. Ensure pipx Path
First, ensure the directory where pipx stores apps is in your PATH environment variable:
pipx ensurepath
###2. Install Backend
Install the Theseus agent backend using pipx:
pipx install theseus_agent
###3. Install and Run UI
Install and run the main UI using npx:
npx theseus-ui
That's it! You're ready to start using Theseus.
##Updating Theseus
If you already have Theseus installed, you can update it using:
pipx install --force theseus_agent
##Terminal UI Installation (Optional)
If you prefer using the terminal interface:
- Install the terminal UI:
npm install -g theseus-tui
- Set your API key as an environment variable:
# For Anthropic
export ANTHROPIC_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# OR for OpenAI
export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# OR for Groq
export GROQ_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
- Run the terminal UI:
theseus-tui
To update the terminal UI:
npm uninstall -g theseus-tui npm install -g theseus-tui
##Running in Debug Mode
To run in debug mode:
theseus-tui --debug
##Local Model Support (Experimental)
To run with a local model:
-
Get deepseek running with ollama
-
Start the local ollama server:
ollama run deepseek-coder:6.7b
- Configure Theseus:
theseus-tui configure
# Select "ollama/deepseek-coder:6.7b" from the model options
- Run with local configuration:
theseus-tui --api_key=FOSS
Warning: Local model support is currently experimental. Expect reduced performance compared to cloud-based models.
##Troubleshooting
If you encounter any issues during installation:
- Ensure all prerequisites are properly installed
- Check that your API key is valid and properly set
- For terminal UI issues, try a clean reinstall:
npm uninstall -g theseus-tui npm install -g theseus-tui
##Next Steps
- Check out the Quick Start Guide to begin using Theseus
- Review the Configuration Guide to customize your setup
- Explore the Features Overview to learn about Theseus capabilities