hub / github.com/coderoad/coderoad-vscode

github.com/coderoad/coderoad-vscode @v0.19.4

Chat with this repo

repository ↗ · DeepWiki ↗ · release v0.19.4 ↗ · + Follow

346 symbols 822 edges 150 files 2 documented · 1%

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

CodeRoad

CodeRoad is a VSCode extension that allows you to create and play interactive coding tutorials in your editor.

Works with a variety of languages: JavaScript, Python, Bash, SQL, with more to come.

CodeRoad Example

📖 Documentation

How CodeRoad Works

Text is written in Markdown. 🔗
Tutorials are built on Git using a TDD pattern. 🔗
Hooks & actions give flexible access to the command line & VSCode API. 📖

▶️ See a video explaining how CodeRoad works

📖 Learn more

Getting Started

Requirements

OS: MacOS, Linux, Windows
VSCode 1.39.2+
Git

Install

install CodeRoad from the VSCode Marketplace.
reload the window (ctrl/cmd + R) to get started.

Start

CodeRoad Example

To start the extension, inside VSCode:

Open an empty VSCode workspace (a project folder)
Launch the app from the VSCode command palette. How?
select “View” > “Command Palette” from the top panel OR press cmd/ctrl + shift + P
in the command palette popup, search for and run CodeRoad:Start

Contributing

CodeRoad is an ambitious project, we're always looking for contributors :)

See CONTRIBUTING.md.

License

AGPL v3

Contact & Support

Create a GitHub issue for bug reports, feature requests, or questions
Reach out at coderoadapp@gmail.com
Leave a review in the VSCode Marketplace
Add a ⭐️ star on GitHub to support the project!

Extension points exported contracts — how you extend this code

Properties (Interface)

* Telemetry * https://github.com/microsoft/vscode-extension-telemetry *

src/services/telemetry/index.ts

Channel (Interface)

(no doc) [1 implementers]

src/channel.ts

CreateCommandProps (Interface)

(no doc)

src/commands.ts

TutorialConfigParams (Interface)

(no doc)

src/actions/utils/tutorialConfig.ts

Props (Interface)

(no doc)

web-app/src/components/Icon/index.tsx

TestRunnerArgs (Interface)

(no doc)

typings/tutorial.d.ts

Progress (Interface)

(no doc)

typings/index.d.ts

Measurements (Interface)

(no doc)

src/services/telemetry/index.ts

Core symbols most depended-on inside this repo

logger

called by 48

src/services/logger/index.ts

src/services/node/index.ts

editorSend

called by 17

web-app/src/services/state/useStateMachine.tsx

parser

called by 15

src/services/testRunner/parser.ts

logger

called by 15

web-app/src/services/logger/index.ts

getProgress

called by 7

web-app/src/containers/Start/getProgress.ts

callWebhookEndpoint

called by 6

src/services/hooks/webhooks.ts

Shape

Function 215

Interface 75

Method 44

Class 12

Languages

TypeScript100%

Modules by API surface

src/services/git/index.ts16 symbols

web-app/src/services/state/actions/editor.ts15 symbols

typings/index.d.ts15 symbols

src/services/hooks/index.ts10 symbols

web-app/src/containers/Tutorial/index.tsx8 symbols

src/services/testRunner/index.ts8 symbols

src/services/hooks/webhooks.ts8 symbols

web-app/src/containers/Start/index.tsx7 symbols

typings/tutorial.d.ts7 symbols

src/services/webview/create.ts7 symbols

src/services/testRunner/parser.ts7 symbols

src/services/node/index.ts7 symbols

For agents

$ claude mcp add coderoad-vscode \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact