コンテンツにスキップ

Get started

このコンテンツはまだ日本語訳がありません。

CodeTutor is a personal AI coding tutor for the terminal, desktop, and browser. The current release is a public beta, not a stable release.

Prefer a guided walkthrough? Open the setup checklist.

Install

Install Node.js and npm first. Then run these commands in your terminal:

Terminal window
npm install -g codetutor@latest
codetutor --version

The latest npm tag currently points to a beta. See downloads and release notes. CodeTutor is not the opencode-ai package.

Sign in

Terminal window
codetutor account login

Open the URL printed by CodeTutor, sign in, and approve the displayed device code. Leave the terminal running until authorization finishes.

Terminal window
codetutor account status

Managed AI requires a CodeTutor account and available usage. You do not need to paste an AI provider key. Credentials are stored in the operating system vault. If authorization succeeds but saving fails, follow the sign-in troubleshooting guide.

Work in your project

Open your project folder in your IDE, then open its integrated terminal. Check that the terminal is in the correct folder:

macOS or Linux
pwd
Windows PowerShell
Get-Location

Then launch the tutor:

Terminal window
codetutor .

The dot selects the current directory. Do not paste a made-up path such as /path/to/your/project; it is not a folder on your computer.

Select a model in the model picker before sending a prompt. Tool-capable models support repository work. Chat-only models are for explanations and do not provide project tools.

Try: “Explain this project and help me write one test. Ask me questions before changing anything.”

Check proposed edits and commands before approving them. Review changes in your IDE and run the project’s tests. Keep a backup or Git commit before making changes.

Learn without an account

Bundled lessons and deterministic checks can run locally without AI or sign-in:

Lesson checks require the separate Bun runtime. Run bun --version; if it is missing, follow the Bun installation guide and reopen your terminal. Initial installation needs internet access. The offline setup walkthrough explains each step.

Terminal window
codetutor learn level beginner
codetutor learn list
codetutor learn start js-01-values --no-tui

Open the workspace path printed by CodeTutor in your editor. Edit the lesson files there—not a different project’s folder.

Terminal window
codetutor learn hint js-01-values

After editing and saving your answer, check it:

Terminal window
codetutor learn check js-01-values

Then view progress:

Terminal window
codetutor learn status

A new starter is supposed to fail its checks. Only passing checks mark it complete. Read the full lesson workflow.

Choose your interface

Terminal

Use codetutor . in the selected project folder. The terminal UI works alongside your editor.

Desktop beta

See desktop downloads. Desktop uses a bundled local server. macOS signing and account-configuration issues remain release gates; read the notes before installing.

Browser

For a local browser interface, start this from your project’s terminal:

Terminal window
codetutor web --hostname 127.0.0.1

Use the local URL it prints and leave that terminal running. Stop it with Ctrl+C when finished. Do not bind the server to a public interface just to fix a connection error.

The hosted app is a separate interface. A hosted website cannot directly read or edit local files on its own. Repository access requires a running local CodeTutor server and an approved pairing. Hosted pairing is still being validated for launch.

Manage your account

Terminal window
codetutor account plan
codetutor account usage
codetutor account sessions

See account and usage guidance for billing, profile, and device management.

Update or uninstall

Update
npm install -g codetutor@latest
codetutor --version
Uninstall the npm CLI
npm uninstall -g codetutor

Uninstalling the CLI is separate from deleting your CodeTutor account or cancelling a subscription. Read troubleshooting if installation, login, or the first session fails.