Skip to content
Back to search

TeachMeCoding

Local-first AI coding tutor with personalized roadmaps, lessons, hands-on practice, and execution-backed assessments. 本地 AI 编程老师:生成学习路线和课件,在真实项目中练习,用运行结果辅助测评。

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked yesterday
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/liangxiao777--teachmecoding/badge.svg)](/listings/liangxiao777--teachmecoding)

HTML

<a href="/listings/liangxiao777--teachmecoding"><img src="/api/listings/liangxiao777--teachmecoding/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Requirements

- [Node.js](https://nodejs.org/) 24.15.0 - [pnpm](https://pnpm.io/) 11.1.0 - Git and Bash on `PATH`.

Native dependencies (`better-sqlite3` and `node-pty`) need Python 3 and compiler tools when prebuilt binaries are unavailable. The macOS `node-pty` patch always builds from source.

| OS | Native build prerequisites | | --- | --- | | macOS | Python 3 and Xcode Command Line Tools (`xcode-select --install`) | | Linux (Ubuntu/Debian) | `sudo apt-get update && sudo apt-get install -y git bash build-essential python3` |

For coding assessments, install any additional language toolchains you need, such as `rustc`, and make them available on `PATH`. Python assessments require `python3`. The Agent does not automatically install missing toolchains.

Install and run

Download `teach-me-coding-0.2.0.tar.gz` and `SHA256SUMS` from [GitHub Releases](https://github.com/liangxiao777/TeachMeCoding/releases/tag/v0.2.0). The same archive works on both supported platforms: it contains prebuilt server and frontend assets, but not Node.js or dependencies. Install the prerequisites above and reopen your terminal so the updated `PATH` takes effect.

npm install --global pnpm@11.1.0
tar -xzf teach-me-coding-0.2.0.tar.gz
cd teach-me-coding-0.2.0
pnpm install --frozen-lockfile
pnpm start

Verify the downloaded archive with `shasum -a 256 -c SHA256SUMS` on macOS or `sha256sum -c SHA256SUMS` on Linux before extracting it.

To build from source instead:

git clone https://github.com/liangxiao777/TeachMeCoding.git
cd TeachMeCoding
pnpm install --frozen-lockfile
pnpm build
pnpm start

Open <http://127.0.0.1:4310>. For development from a source checkout, use `pnpm dev` instead (frontend at <http://127.0.0.1:5173>); see the [development guide](docs/development.md).

Configure a model

Open **Settings → Model configuration** and choose a provider, model, and sign-in method. Credentials are stored only in the local data directory (default: `~/.teach-me-coding/`) and are never sent back to the browser.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 172 lines
  1. <p align="center">
  2. <img src="apps/web/public/icon.svg" width="80" alt="TeachMeCoding logo" />
  3. </p>
  4. <h1 align="center">TeachMeCoding</h1>
  5. <p align="center">
  6. English · <a href="README.zh.md">简体中文</a>
  7. </p>
  8. <p align="center">
  9. An AI coding tutor that runs locally: turn learning goals into a roadmap and lessons, practice in real projects, and get assessed using real execution results.
  10. </p>
  11. <p align="center">
  12. <a href="LICENSE"><img alt="License Apache-2.0" src="https://img.shields.io/badge/license-Apache--2.0-blue" /></a>
  13. <img alt="Node 24.15" src="https://img.shields.io/badge/node-24.15-339933?logo=node.js&logoColor=white" />
  14. <img alt="pnpm 11.1" src="https://img.shields.io/badge/pnpm-11.1-F69220?logo=pnpm&logoColor=white" />
  15. <img alt="Platform macOS, Linux" src="https://img.shields.io/badge/platform-macOS%20%7C%20Linux-lightgrey" />
  16. <img alt="Status alpha" src="https://img.shields.io/badge/status-alpha-orange" />
  17. </p>
  18. <p align="center">
  19. <a href="#quick-start">Quick start</a> ·
  20. <a href="#documentation">Documentation</a> ·
  21. <a href="CONTRIBUTING.md">Contributing</a> ·
  22. <a href="SECURITY.md">Security</a>
  23. </p>
  24. ![TeachMeCoding learning roadmap and agent conversation](docs/images/route-agent-en.png)
  25. TeachMeCoding creates a separate learning space for each learning goal. The teaching agent clarifies your needs, plans a learning roadmap, and writes lessons. You practice in the built-in IDE and local terminal, and coding submissions run on your machine before the model evaluates the results. All data is stored locally in SQLite and project directories, and the entire application runs in a single Node process.
  26. > [!WARNING]
  27. > The agent can read files, run Bash commands, and access the network with the permissions of the system account running the server. It is **not a sandbox**. Run it only in an environment where you trust the model, tools, and reference materials. See [SECURITY.md](SECURITY.md).
  28. ## Contents
  29. - [Features](#features)
  30. - [Project status](#project-status)
  31. - [Quick start](#quick-start)
  32. - [Usage](#usage)
  33. - [Configuration](#configuration)
  34. - [Documentation](#documentation)
  35. - [Contributing](#contributing)
  36. - [Acknowledgments](#acknowledgments)
  37. - [License](#license)
  38. ## Features
  39. - **A complete learning workflow**: clarify your needs → plan a roadmap → study lessons and practice coding → receive assessments and feedback.
  40. - **An adaptable learning roadmap**: organized into stages and units, with units unlocking in order once lessons for preceding units are ready.
  41. - **Real projects and terminals**: each learning space has a project directory on disk. The editor saves as you type, and the terminal is a real shell.
  42. - **Assessments backed by execution evidence**: coding submissions run locally and their output is checked, with support for Python, JavaScript, TypeScript, Rust, and Bash.
  43. - **Approve changes before they take effect**: roadmap adjustments, lesson rewrites, file edits, and learning conclusions are presented as proposals. You can also enable YOLO mode per conversation to accept them automatically.
  44. - **Multiple model providers**: connect through [Pi](https://github.com/earendil-works/pi), with API key or OAuth sign-in and visible context usage.
  45. - **Reference library**: upload reference materials in any format for the agent to read as needed.
  46. - **Web access**: 14 optional search services (including DuckDuckGo, which requires no API key), plus built-in web fetching.
  47. - **MCP and Skills**: add MCP servers in Settings, and browse and install Skills from [skills.sh](https://skills.sh).
  48. - **English and Simplified Chinese interfaces**, with light and dark themes.
  49. <table>
  50. <tr>
  51. <td><img src="docs/images/lesson-en.png" alt="Unit page showing a saved lesson in the demo learning space" /></td>
  52. <td><img src="docs/images/ide-fullscreen-en.png" alt="Full-screen IDE with a code editor and local terminal" /></td>
  53. </tr>
  54. <tr>
  55. <td align="center">Lessons and coding practice</td>
  56. <td align="center">Full-screen IDE and local terminal</td>
  57. </tr>
  58. </table>
  59. <sub>Screenshots show an isolated, locally running demo learning space with English demo content, not a live model run.</sub>
  60. ## Project status
  61. Version **0.2.0** is an early release. Features, interfaces, and data formats may change.
  62. Supports **macOS and Linux (Ubuntu/Debian) only**; Windows is unsupported.
  63. Local verification with Node 24.15.0 covers installation, type checks, build, tests, and SQLite/PTY checks on **macOS 26 / arm64** and in a non-root **Debian 12 / arm64 Docker** environment. macOS also has Google Chrome browser execution coverage. Linux browser checks are **x86_64-only**; Linux arm64 has backend/native verification only. Intel Macs remain unverified. See the [development guide](docs/development.md#testing) for test commands and CI coverage.
  64. ## Quick start
  65. ### Requirements
  66. - [Node.js](https://nodejs.org/) 24.15.0
  67. - [pnpm](https://pnpm.io/) 11.1.0
  68. - Git and Bash on `PATH`.
  69. Native dependencies (`better-sqlite3` and `node-pty`) need Python 3 and compiler tools when prebuilt binaries are unavailable. The macOS `node-pty` patch always builds from source.
  70. | OS | Native build prerequisites |
  71. | --- | --- |
  72. | macOS | Python 3 and Xcode Command Line Tools (`xcode-select --install`) |
  73. | Linux (Ubuntu/Debian) | `sudo apt-get update && sudo apt-get install -y git bash build-essential python3` |
  74. For coding assessments, install any additional language toolchains you need, such as `rustc`, and make them available on `PATH`. Python assessments require `python3`. The Agent does not automatically install missing toolchains.
  75. ### Install and run
  76. Download `teach-me-coding-0.2.0.tar.gz` and `SHA256SUMS` from [GitHub Releases](https://github.com/liangxiao777/TeachMeCoding/releases/tag/v0.2.0). The same archive works on both supported platforms: it contains prebuilt server and frontend assets, but not Node.js or dependencies. Install the prerequisites above and reopen your terminal so the updated `PATH` takes effect.
  77. ```sh
  78. npm install --global pnpm@11.1.0
  79. tar -xzf teach-me-coding-0.2.0.tar.gz
  80. cd teach-me-coding-0.2.0
  81. pnpm install --frozen-lockfile
  82. pnpm start
  83. ```
  84. Verify the downloaded archive with `shasum -a 256 -c SHA256SUMS` on macOS or `sha256sum -c SHA256SUMS` on Linux before extracting it.
  85. To build from source instead:
  86. ```sh
  87. git clone https://github.com/liangxiao777/TeachMeCoding.git
  88. cd TeachMeCoding
  89. pnpm install --frozen-lockfile
  90. pnpm build
  91. pnpm start
  92. ```
  93. Open <http://127.0.0.1:4310>. For development from a source checkout, use `pnpm dev` instead (frontend at <http://127.0.0.1:5173>); see the [development guide](docs/development.md).
  94. ### Configure a model
  95. Open **Settings → Model configuration** and choose a provider, model, and sign-in method. Credentials are stored only in the local data directory (default: `~/.teach-me-coding/`) and are never sent back to the browser.
  96. ## Usage
  97. 1. Describe what you want to learn on the home page, for example: “I want to learn Rust and build a command-line tool.”
  98. 2. Answer the agent's questions about your background, goals, and schedule, then confirm the requirements summary.
  99. 3. Review the generated learning roadmap and ask the agent to adjust it if needed.
  100. 4. Work through each unit's lessons, practice in the IDE and terminal, and ask the agent questions whenever you need help.
  101. 5. Complete the assessments and use the feedback to guide your next steps.
  102. ## Configuration
  103. - **Startup options** (data directory, port, listen address, and more) are set through environment variables or a `.env` file in the project root. See [`.env.example`](.env.example).
  104. - **Models, search, MCP, and Skills** are managed in the application's **Settings** page.
  105. By default, the server listens only on `127.0.0.1`. Set `HOST=0.0.0.0` to allow access over your local network, but **there is no login authentication**. Use this only on a trusted network.
  106. See the [configuration guide](docs/configuration.md) for all options, the data directory layout, and backup instructions.
  107. ## Documentation
  108. - [Configuration](docs/configuration.md): startup options, models, data directory and backups, local network access, search, web fetching, MCP, and Skills
  109. - [Architecture](docs/architecture.md): components, agent scenarios and tools, proposals and YOLO mode, run lifecycle, and local execution boundaries
  110. - [Development guide](docs/development.md): development environment, project structure, and tests
  111. - [UI translation](docs/translating.md): translation conventions and checks
  112. - [Contributing](CONTRIBUTING.md): issue reporting and the pull request process
  113. - [Security policy](SECURITY.md): security model and vulnerability reporting
  114. ## Contributing
  115. Bug reports and suggestions are welcome through [Issues](https://github.com/liangxiao777/TeachMeCoding/issues). Please read [CONTRIBUTING.md](CONTRIBUTING.md) before submitting a pull request.
  116. ## Acknowledgments
  117. - [Pi](https://github.com/earendil-works/pi): agent core, model integration, MCP client, and Skills loading
  118. - [AI Elements](https://ai-sdk.dev/elements) and [shadcn/ui](https://ui.shadcn.com/): conversation and input components
  119. - [OpenClaw](https://github.com/openclaw/openclaw): reference implementation for search and web fetching tools
  120. - [Skills CLI](https://github.com/vercel-labs/skills) and [skills.sh](https://skills.sh)
  121. - [xterm.js](https://xtermjs.org/), [node-pty](https://github.com/microsoft/node-pty), [better-sqlite3](https://github.com/WiseLibs/better-sqlite3), [Hono](https://hono.dev/), [CodeMirror](https://codemirror.net/)
  122. ## License
  123. This project is open source under the [Apache License 2.0](LICENSE).
  124. Copyright 2026 lxiao ([@liangxiao777](https://github.com/liangxiao777))

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.