Skip to content

VedSoni-dev/teachy

Repository files navigation

Teachy

Teachy is free & open-source macOS software — the ultimate free teaching companion. A 1:1 tutor in your menu bar that sees your screen, points at real UI, and coaches you until something actually runs.

License: MIT Download Website

North star: free 1:1 teaching for everyone — practice on the real screen, not another video player.

Born from Farza’s Clicky experiments. This line is Teachy: courses-first, teach-by-doing, open curriculum.

Website: vedsoni-dev.github.io/teachy · Launch posts: docs/LAUNCH_POSTS.md

Teachy on macOS

Free download

Download Teachy.dmg · All releases

First open (Gatekeeper)

Community builds ship without Apple’s paid Developer ID / notarization (keeps Teachy free for maintainers too). macOS may say it “can’t verify” the developer:

  1. Drag Teachy to Applications
  2. Right-clickOpenOpen
    (or System Settings → Privacy & Security → Open Anyway)
  3. Grant Microphone, Screen Recording, Accessibility
  4. Run the local Teachy proxy (below) with an OpenRouter key

Installed apps can Check for Updates… under Home → Updates (Sparkle).

What it does

  • Learn paths — goal-based courses (First Win with AI, Use AI to Code, GitHub, and more)
  • Teacher clips — optional videos beside the cursor, then hands-on coaching
  • Live coaching[POINT:…] on your real screen, hints, “do it for me,” teach-backs
  • Open curriculum — course JSON + Mux/HLS videos via courses/ and Teachy Academy

MIT licensed. Hack on it, ship courses, build companies — go wild.

Quick start (Claude / Cursor)

Clone this repo. Read AGENTS.md (or CLAUDE.md — same file).

I want Teachy running locally on my Mac.

Help me set up the worker proxy with my API keys, then get the Teachy target
building in Xcode (leanring-buddy scheme / PRODUCT_NAME Teachy).

Manual setup (from source)

Prerequisites

  • macOS 14.2+ (ScreenCaptureKit)
  • Xcode 15+
  • Node.js 18+ (local proxy / Cloudflare Worker)
  • API keys: OpenRouter (recommended), AssemblyAI optional for streaming STT

1. API proxy

The app never ships secrets. All model / STT traffic goes through the Teachy proxy.

cd worker
cp .env.template .env   # add OPENROUTER_API_KEY (and others as needed)
npm install
npm run local           # http://localhost:8787
npm run harness         # optional smoke test

For production Cloudflare:

cd worker
npx wrangler secret put OPENROUTER_API_KEY
npx wrangler secret put ASSEMBLYAI_API_KEY   # optional
npx wrangler deploy

Point the app at your worker via WorkerBaseURL in leanring-buddy/Info.plist.

2. Build & run the Mac app

open leanring-buddy.xcodeproj
  1. Select the leanring-buddy scheme (legacy project name — the app displays as Teachy)
  2. Set your Apple Development Team (Signing & Capabilities) so Accessibility / Screen Recording stick across rebuilds
  3. Cmd+R

Do not use xcodebuild from the terminal for day-to-day runs — it tends to invalidate TCC permissions.

3. Permissions

Grant: Microphone, Screen Recording, Accessibility (and Speech Recognition if using Apple Speech).

Path Purpose
~/.teachy/courses/ Installed course JSON (falls back to ~/.clicky/courses/)
~/.teachy/connectors/ OpenAPI / HTTP connections

Releasing updates (maintainers)

See scripts/README.md. No Apple paid cert required by default:

./scripts/release.sh 1.0

That ships a free GitHub Release DMG and updates appcast.xml so existing installs can update. If you later join the Apple Developer Program: NOTARIZE=1 ./scripts/release.sh 1.0.

Open curriculum

Architecture (short)

Menu-bar Teachy → notch panel → LessonPlayer / companion voice → Teachy proxy (worker/) → OpenRouter + optional AssemblyAI. Mac tools run locally. Full map: AGENTS.md.

Contributing

See CONTRIBUTING.md and CODE_OF_CONDUCT.md. Security: SECURITY.md.

License

MIT — LICENSE. Third-party notices: NOTICE.

Credits

Originally created by Farza as Clicky. Teachy continues that spirit as an open teaching platform for everyone.

About

Teachy — free open-source macOS teaching companion. Ultimate free teaching software.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors