Install Now
How to install HKUDS/DeepTutor. Official installation instructions. Project installation guide. Framework or library installation. Build installation instructions. How to setup and install from GitHub. Installation steps and setup instructions. Official docs and installation instructions GitHub.
HKUDS/DeepTutor Installation Guide
How to install HKUDS/DeepTutor. Official project installation instructions and setup guide.
⚡
Automated Install (Recommended)
Quick installation instructions for HKUDS/DeepTutor. This is the fastest way to complete project installation and setup.
Install via curl
curl -fsSL https://hexmos.com/ipm-install | bash &&
ipm i HKUDS/DeepTutoror
Install via npx
npx @hexmos/ipm i HKUDS/DeepTutorPrerequisites
Git
version-control-systemPython
programming-languageVersion: 3.11
Conda
package-managerNode.js and npm
runtimeDocker
containerizationManual Installation Methods
Manual installation instructions. How to install from GitHub source.
Setup Tour (Recommended)
git clone https://github.com/HKUDS/DeepTutor.git
cd DeepTutor
conda create -n deeptutor python=3.11
conda activate deeptutor
python scripts/start_tour.pyManual Local Install
git clone https://github.com/HKUDS/DeepTutor.git
cd DeepTutor
conda create -n deeptutor python=3.11
conda activate deeptutor
pip install -e ".[server]"
cd web
npm install
cd ..
cp .env.example .env
python -m deeptutor.api.run_server
cd web && npm run dev -- -p 3782Docker Deployment (Official Image)
git clone https://github.com/HKUDS/DeepTutor.git
cd DeepTutor
cp .env.example .env
docker compose -f docker-compose.ghcr.yml up -dDocker Deployment (Build from Source)
git clone https://github.com/HKUDS/DeepTutor.git
cd DeepTutor
cp .env.example .env
docker compose up -dCLI Only Installation
git clone https://github.com/HKUDS/DeepTutor.git
cd DeepTutor
pip install -e ".[cli]"Post Installation Steps
- Configure .env file with your API keys for LLM and Embedding providers.
- Access the web UI at http://localhost:3782
- For CLI usage, you can run commands like 'deeptutor chat' or 'deeptutor run chat "Explain concept"'.