Skip to content

DeepTutor CLI Assistant

Lets an agent set up, configure, and run the DeepTutor learning platform from the command line.

Repository
HKUDS/DeepTutor
Stars
54,053
Licence
Apache-2.0
Files
15 files

What it does

Once installed, the agent knows the DeepTutor command-line interface and can install and configure the platform, check its health, manage knowledge bases of documents, start tutoring and research tasks such as quizzes, deep solve, and deep research, and launch the API server or Web app. It is told to read the project's setup guide first, reuse existing checkouts, reference API keys by environment variable rather than printing them, and report only verified readiness. Note that this file is a command reference and setup guide; it does not itself contain the full DeepTutor software.

Great for

  • Developers who want an AI agent to install and maintain a local DeepTutor instance
  • Educators or students who want to run DeepTutor tasks such as quiz generation or research from a terminal
  • Teams building a knowledge base from their own PDFs and documents via the command line

Skip it if

  • People who only want to use DeepTutor in a browser: the skill mainly targets terminal and setup work, and the Web app itself is installed separately
  • Users who do not have Python 3.11–3.14 or who cannot provide their own model provider API keys, since setup cannot complete without them
  • Sensitive document collections uploaded into knowledge bases when the configured LLM or search providers are cloud services, because content may leave the machine

Try asking

  • “Install DeepTutor from source and check whether my local setup is ready”
  • “Create a knowledge base from the PDFs in ./papers and search it for attention mechanisms”
  • “Run a deep research task on Fourier transforms and save the result as a report”
  • “Apply a setup JSON profile to configure my model provider without printing my API key”
Step-by-step guide: how to use DeepTutor CLI AssistantInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 15 original files, the Apache-2.0 licence and an attribution note.

    deeptutor-cli.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip deeptutor-cli.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip deeptutor-cli.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Run deeptutor doctor first and use the non-online check before paying for a live LLM request with --online
  • Keep API keys in environment variables and check with deeptutor config show, which redacts credentials
  • Review the source of the referenced setup guide and confirm commands with --help on your installed version before running them

What's inside

  • .pre-commit-config.yaml
  • AGENTS.md
  • build_metadata.py
  • build_support.py
  • CODE_OF_CONDUCT.md
  • Communication.md
  • compose.codex-oauth.yaml
  • compose.yaml
  • CONTRIBUTING.md
  • CONTRIBUTORS.md
  • docker-compose.dev.yml
  • docker-compose.ghcr.yml
  • docker-compose.yml
  • SKILL.md
  • THIRD_PARTY_NOTICES.md

Redistributed unmodified from HKUDS/DeepTutor under the Apache-2.0 licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.