aitutor

command module
v0.1.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 21, 2026 License: MIT Imports: 7 Imported by: 0

README

AITutor

Interactive terminal-based tutorial for AI coding concepts. Learn context windows, MCP, tools, subagents, and more through hands-on lessons with visualizations and quizzes — like vimtutor, but for AI-assisted development.

Go

AITutor Demo

Install

No setup needed — just run:

npx @aitutor/cli@latest

Or install globally:

npm install -g @aitutor/cli@latest
aitutor
Homebrew
brew tap naorpeled/tap
brew install aitutor
aitutor
Go
go install github.com/naorpeled/aitutor@latest
aitutor
Build from source
git clone https://github.com/naorpeled/aitutor.git
cd aitutor
make build
./aitutor

Curriculum

Beginner
# Lesson What You'll Learn
1 What is an AI Coding Assistant? The observe-think-act agent loop
2 Context Window How token budgets work, MCP tool costs, compression
3 Tools Glob, Read, Edit, Bash — the core tool chain
4 Prompt Engineering Writing effective prompts for AI assistants
Intermediate
# Lesson What You'll Learn
5 AGENTS.md / CLAUDE.md Project-specific AI instructions and scoping
6 Execution Modes Plan mode vs execution mode decision-making
7 Hooks Lifecycle hooks and automation triggers
8 Memory & Persistence Session memory, persistent storage, CLAUDE.md
9 The Agentic Loop Read → Think → Act → Observe iteration cycle
10 Prompting Techniques Seven techniques for better AI-generated code
11 AI Code Review Bug spotting, verification strategies, common AI mistakes
Advanced
# Lesson What You'll Learn
12 MCP (Model Context Protocol) Client-server architecture, browsing and calling tools
13 Skills Lazy-loaded skill system and slash commands
14 Subagents Parallel agent fan-out for complex tasks
15 Git Worktrees Isolated workspaces for parallel development
16 Tool Search & Deferred Tools On-demand tool loading to save context
17 Batch Tool Calls Per-tool execution policies and parallel batching

How It Works

Each lesson has three phases:

  1. Theory — Scrollable content explaining the concept
  2. Visualization — Interactive ASCII visualization you can manipulate
  3. Quiz — Multiple choice, fill-in-the-blank, or ordering questions

Progress saves automatically to ~/.aitutor/progress.json and resumes across sessions.

Keys

Key Action
q / Ctrl+C Quit
Tab Toggle sidebar
n / p Next / previous lesson
/ Enter Advance to next phase
/ Backspace Go back a phase
↑/↓ or j/k Scroll / navigate
Enter / Space Interact with visualizations
? Help overlay

Project Structure

aitutor/
├── main.go                          # Entry point
├── internal/
│   ├── app/                         # Root TUI model, keys, messages
│   ├── ui/                          # Header, footer, sidebar, styles, layout
│   ├── lesson/                      # Lesson state machine, registry, renderer
│   ├── content/
│   │   ├── beginner/                # Lessons 1-4
│   │   ├── intermediate/            # Lessons 5-11
│   │   └── advanced/                # Lessons 12-17
│   ├── viz/                         # Interactive visualizations
│   ├── quiz/                        # Quiz system (MC, fill-blank, ordering)
│   └── progress/                    # JSON persistence, progress bar
└── pkg/types/                       # Shared types (Tier, LessonDef, etc.)

Dependencies

No other external dependencies.

Contributing

Something missing? Something wrong? Feel free to open an issue or submit a PR at github.com/naorpeled/aitutor.

Disclaimer

Content is community-contributed and may be AI-assisted. While we strive for accuracy, it may contain errors. This is not a substitute for professional training. Contributions and corrections are welcome.

License

MIT

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
app
ui
viz
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL