Dokumentation

Kodo Forge is a Terminal User Interface (TUI) for learning web development. Unlike browser-based platforms like Udemy, Coursera or freeCodeCamp, Kodo Forge runs entirely inside your terminal — the same tool professional developers use every day.

Why a terminal? Because it eliminates distractions. No browser tabs, no notifications, no ads. Just you and the material. Research shows that deep-focus, distraction-free environments dramatically improve learning retention.

When you launch Kodo Forge, the engine scans your directory for a platform.json configuration file. This file tells the engine where your courses are and how they're structured.

Everything is keyboard-driven. Navigate with arrow keys, select with Enter, go back with Escape. It's designed to feel like a native terminal application with smooth animations.

The Kinetic Reader is our custom-built text progression engine. Instead of dumping an entire page of text at you, it reveals content progressively — section by section, paragraph by paragraph.

Kodo Forge includes a built-in spaced repetition system based on proven cognitive science. After you complete a section, key concepts are automatically added to your review queue.

Kodo Forge is 100% free and open source under the MIT license. We believe high-quality programming education should be accessible to everyone, regardless of income or location.

We believe in learning by doing. The engine itself is a great TypeScript project to study — it demonstrates clean architecture, state management, terminal rendering, and data-driven design patterns.

Option 1: Download the executable (recommended for learners)

Go to the Download page and grab the binary for your operating system. Place it in any directory and run it. That's it — instant learning environment.

Option 2: Run from source (recommended for developers)

If you want to contribute, modify, or study the code:

git clone https://github.com/lia-xim/Kodo-Forge-TUI-for-learning-Coding.git
cd Kodo-Forge-TUI-for-learning-Coding/platform
npm install
npm start

Kodo Forge is a data-driven engine. Courses are just folders of Markdown files. You can create courses on any topic — programming, languages, science, history, anything that can be taught through text.

Step 1: Create your directory structure

my-project/
├── platform.json          # Course registry
├── my-course/
│   ├── 01-introduction/
│   │   ├── README.md      # Lesson overview
│   │   └── sections/
│   │       ├── 01-welcome.md
│   │       ├── 02-setup.md
│   │       └── 03-first-steps.md
│   ├── 02-basics/
│   │   ├── README.md
│   │   └── sections/
│   │       ├── 01-core-concepts.md
│   │       └── 02-hands-on.md
│   └── ...

Step 2: Register in platform.json

{
  "courses": [{
    "id": "my-course",
    "name": "My Amazing Course",
    "description": "Learn something amazing",
    "directory": "my-course",
    "color": "blue",
    "icon": "MC",
    "totalLessons": 10,
    "status": "active"
  }],
  "activeCourse": "my-course"
}

Step 3: Write your Markdown content

Step 4: Test with the engine

npm start

The engine auto-detects your course and renders it as a beautiful TUI.

Using AI to create courses: You can use AI assistants (Claude, ChatGPT, Gemini) to generate course content. We provide a workflow file at .agent/workflows/create-kodo-course.md that teaches AI assistants the exact directory structure, Markdown conventions, and didactic best practices. Simply tell your AI: "Create a Kodo Forge course about [topic]" and point it to this workflow.

Headings Use #, ##, ### for section headers.

Code Blocks Use fenced code blocks with language specification for syntax highlighting.

Annotated Code (Kodo Forge exclusive) Add [annotated] after the language name. Lines ending with // comment get displayed as side annotations.

Tables Standard Markdown tables with automatic column sizing and alignment.

Mermaid Diagrams Use mermaid as the language in a fenced code block. Supports flowcharts, sequence diagrams, and more.

Kodo Forge is built with TypeScript and runs on Node.js (or as a compiled Bun executable). The codebase is organized into clean, modular components: