Skip to content

getting-started.md

Latest commit

 

History

History
87 lines (62 loc) · 2.15 KB

getting-started.md

File metadata and controls

87 lines (62 loc) · 2.15 KB
Raw

Getting started

Install

Pick one:

# Isolated CLI install (recommended)
pipx install expert-mentor

# Plain pip
pip install expert-mentor

# From source, with the skill linked too
git clone https://github.com/voidstackloop/expert-mentor
cd expert-mentor
./install.sh

install.sh puts the mentor command on your PATH, links the skill into ~/.claude/skills/ and ~/.config/opencode/skills/, and runs a health check. Undo it with ./uninstall.sh.

You can also run it without installing anything:

python3 scripts/expert_mentor.py --field "Rust"
./bin/mentor --field "Rust"

First prompt

Generate a reusable teaching system prompt:

mentor --field "organic chemistry" --level intermediate

The output is a complete system prompt. Paste it into any chat as the system prompt, or hand it to an API. To get a request body you can send directly:

mentor --field "contract law" --provider claude --emit json
mentor --field "Rust" --provider chatgpt --emit json
mentor --field "Rust" --provider ollama --emit modelfile

First live session

mentor run --field "Rust" --provider ollama --model qwen2.5:7b

Inside a session:

  • /reset clears the conversation history
  • /exit (or Ctrl-C) quits
  • Token usage is printed after each turn on stderr

To use a cloud provider, set an API key first:

export ANTHROPIC_API_KEY=...      # for --provider claude
export OPENAI_API_KEY=...         # for --provider chatgpt
mentor run --field "Rust" --provider claude

Make it remember you

mentor run --field "Rust" --provider claude --remember

The learner is named from the field (rust). After the session:

mentor progress rust          # see mastered / shaky / misconceptions
mentor review rust --apply    # let the model update the profile from the transcript
mentor cards rust --generate  # build flashcards
mentor quiz rust              # review them with spaced repetition

Next steps