aitutor AGENTS.md

A project guide for AITutor, a terminal program that teaches AI coding concepts through lessons, visual explanations, and quizzes. It documents the project's structure and the patterns used to add lessons.

In plain words
What is it for?
Use it when working on AITutor, especially to inspect its Go and Bubble Tea architecture, add beginner-to-advanced lessons, create visualizations, or work with quizzes and saved progress.
Why use it?
It helps contributors understand where the application starts, how lesson progress works, where content belongs, and how the main components fit together.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/naorpeled/aitutor/agents-md
Clone the repo
git clone --depth 1 https://github.com/naorpeled/aitutor

Made for: Codex, OpenCode.

Per session 1,185 This file is loaded in full into every session.
When invoked 1,185 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.01185 $0.01185
Opus 5 $0.00593 $0.00593
Sonnet 5 $0.00237 $0.00237
Haiku 4.5 $0.00119 $0.00119

Measured 2d ago against content hash 5d1906a2100b, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

aitutor AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 105 lines

How it starts

The opening of the file, as written. The whole thing — 105 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

Project Overview

AITutor is an interactive terminal-based tutorial for AI coding concepts, built with Go and the Charm ecosystem (Bubbletea, Lipgloss, Bubbles). It teaches through theory, interactive visualizations, and quizzes across 17 lessons in 3 tiers (Beginner, Intermediate, Advanced).

Architecture

  • Entry point: main.go — blank-imports all content packages to trigger init() lesson registration
  • App model: internal/app/app.go — root Bubbletea model orchestrating header, footer, sidebar, lesson model, progress, welcome screen, and help overlay
  • Lesson state machine: internal/lesson/model.go — phases: Theory → Visualization → Quiz → Complete
  • Content: internal/content/{beginner,intermediate,advanced}/ — each file registers a LessonDef via init()
  • Visualizations: internal/viz/ — each viz implements the viz.Model interface (Init/Update/View)
  • Quiz: internal/quiz/ — supports MultipleChoice, FillBlank, and Ordering question types
  • Progress: internal/progress/ — persists to ~/.aitutor/progress.json
  • Types: pkg/types/types.go — shared types to avoid circular imports

Key Patterns

Adding a New Lesson

  1. Create internal/content/<tier>/NN_topic.go
  2. In init(), call lesson.Register(types.LessonDef{...}) with ID, Title, Tier, Theory, VizBuilder, and Questions
  3. Create the visualization in internal/viz/ implementing viz.Model interface
  4. The lesson auto-registers — no wiring needed
  5. Update internal/ui/header.go default Total if needed (it gets overridden at runtime but keeps the default accurate)

VizBuilder Uses interface{}

VizBuilder returns interface{} (not viz.Model) to avoid circular imports between types and viz packages. The lesson package does the type assertion.

Key Handling

  • App-level keys (quit, tab, n/p, →/← for phase navigation, ?) are handled in app.go
  • (right arrow) advances phases from any phase — this is the primary "next phase" key
  • (left arrow) and Backspace go back a phase
  • Enter advances from Theory phase, but in Viz/Quiz phases it falls through to the viz/quiz for interaction
  • Tab is reserved for sidebar toggle — visualizations must not use Tab
  • Visualizations should use h/l for horizontal navigation, not left/right arrows (reserved for phase nav)

Read the full file on GitHub · 105 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 105 lines · 1,185 tokens per session scan A 5d1906a2100b

Subscribe to this mod's changes

aitutor AGENTS.md is an instructions file published in the GitHub repository naorpeled/aitutor (218 stars, last pushed 5d ago), licensed MIT. It adds 1,185 tokens to every session, about $0.0059 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories