Get Started
DeepTutor ships four installation paths. They all share one workspace layout: settings live in data/user/settings/ under the directory you launch from (or under DEEPTUTOR_HOME / deeptutor start --home if you set one explicitly). Knowledge bases, memory, Partner runtime state, multi-user accounts, and audit logs also live under the same data/ tree, so deployments only need to persist that tree.
For the full app, the recommended flow is pick a workspace directory → install → deeptutor init → deeptutor start.
Pick a path
Section titled “Pick a path”| Option | When to use | Page |
|---|---|---|
| PyPI | First-time users, want the smoothest path, no clone | Install from PyPI |
| From Source | Hacking on the codebase, want hot reload | Install from Source |
| Docker | Production deployments, hosted hosts, persistent volumes | Docker |
| CLI Only | Headless server, agent harness, no Web UI needed | CLI-Only Install |
🧪 Trying a pre-release? Plain
pip install -U deeptutorstays on stable — PyPI skips pre-release versions. Opt in withpip install --pre -U deeptutor, or pin an exact version withpip install -U "deeptutor==<version>".
Minimum requirements
Section titled “Minimum requirements”| Component | Version |
|---|---|
| Python | 3.11–3.13 |
| Node.js | 20+ (PyPI) / 22 LTS (from source, matches CI + Docker) |
| RAM | 4 GB free |
| Disk | 2 GB free |
You’ll also need an LLM API key (OpenAI, Anthropic, Gemini, DeepSeek, Azure, Ollama, LM Studio, llama.cpp, vLLM, or any OpenAI-compatible endpoint) and ideally an embedding API key if you plan to use Knowledge Bases.
What gets bound
Section titled “What gets bound”After deeptutor start, two services come up:
| Service | Default port |
|---|---|
| FastAPI backend | 8001 |
| Next.js frontend | 3782 |
Both are overridable via data/user/settings/system.json or during deeptutor init.
After install
Section titled “After install”Once you can reach http://localhost:3782/:
- Explore DeepTutor — a tour of the Chat, Partners, Co-Writer, Book, Knowledge, Space, Memory, and Settings
- DeepTutor CLI — drive everything from the terminal
- Partners & Channels — connect autonomous tutors to WeChat, WeCom, QQ, Telegram, Slack, Feishu, and more
- Multi-User Deployment — host DeepTutor for a team
If something breaks, jump to Troubleshooting.