CLI

The CodeTutor CLI by default starts the TUI when run without any arguments.

opencode

But it also accepts commands as documented on this page. This allows you to interact with CodeTutor programmatically.

codetutor run "Explain how closures work in JavaScript"

---

tui

Start the CodeTutor terminal user interface.

opencode [project]

Flags

Flag	Short	Description
--continue	-c	Continue the last session
--session	-s	Session ID to continue
--fork		Fork the session when continuing (use with --continue or --session)
--prompt		Prompt to use
--model	-m	Model to use in the form of provider/model
--agent		Agent to use
--auto		Auto-approve permissions that are not explicitly denied
--port		Port to listen on
--hostname		Hostname to listen on
--mdns		Enable mDNS discovery
--mdns-domain		Custom mDNS domain name
--cors		Additional browser origin(s) to allow CORS

---

Commands

The CodeTutor CLI also has the following commands.

---

agent

Manage agents for CodeTutor.

codetutor agent [command]

---

create

Create a new agent with custom configuration.

codetutor agent create

This command will guide you through creating a new agent with a custom system prompt and permission configuration. Anything you don’t allow is denied in the generated agent’s frontmatter.

Flags

Flag	Short	Description
--path		Directory to write the agent file to (defaults to global or .codetutor/agent based on the prompt)
--description		What the agent should do
--mode		Agent mode: all, primary, or subagent
--permissions		Comma-separated list of permissions to allow (default: all). Available: bash, read, edit, glob, grep, webfetch, task, todowrite, websearch, lsp, skill. Anything omitted is denied. Alias: --tools
--model	-m	Model to use, in provider/model format

Passing all of --path, --description, --mode, and --permissions runs the command non-interactively.

---

list

List all available agents.

codetutor agent list

---

attach

Attach a terminal to an already running CodeTutor backend server started via serve or web commands.

codetutor attach [url]

This allows using the TUI with a remote CodeTutor backend. For example:

# Start the backend server for web/mobile access
codetutor web --port 4096 --hostname 0.0.0.0

# In another terminal, attach the TUI to the running backend
codetutor attach http://10.20.30.40:4096

Flags

Flag	Short	Description
--dir		Working directory to start TUI in
--continue	-c	Continue the last session
--session	-s	Session ID to continue
--fork		Fork the session when continuing (use with --continue or --session)
--password	-p	Basic auth password (defaults to CODETUTOR_SERVER_PASSWORD)
--username	-u	Basic auth username (defaults to CODETUTOR_SERVER_USERNAME or codetutor)

---

auth

Command to manage credentials and login for providers.

codetutor auth [command]

---

login

CodeTutor is powered by the provider list at Models.dev, so you can use codetutor auth login to configure API keys for any provider you’d like to use. This is stored in ~/.local/share/opencode/auth.json.

codetutor auth login

When CodeTutor starts up it loads the providers from the credentials file. And if there are any keys defined in your environments or a .env file in your project.

Flags

Flag	Short	Description
--provider	-p	Provider ID or name to log in to
--method	-m	Login method label to use, skipping method selection

---

list

Lists all the authenticated providers as stored in the credentials file.

codetutor auth list

Or the short version.

codetutor auth ls

---

logout

Logs you out of a provider by clearing it from the credentials file.

codetutor auth logout

---

github

Manage the GitHub agent for repository automation.

codetutor github [command]

---

install

Install the GitHub agent in your repository.

codetutor github install

This sets up the necessary GitHub Actions workflow and guides you through the configuration process. Learn more.

---

run

Run the GitHub agent. This is typically used in GitHub Actions.

codetutor github run

Flags

Flag	Description
--event	GitHub mock event to run the agent for
--token	GitHub personal access token

---

mcp

Manage Model Context Protocol servers.

codetutor mcp [command]

---

add

Add an MCP server to your configuration.

codetutor mcp add

This command will guide you through adding either a local or remote MCP server.

---

list

List all configured MCP servers and their connection status.

codetutor mcp list

Or use the short version.

codetutor mcp ls

---

auth

Authenticate with an OAuth-enabled MCP server.

codetutor mcp auth [name]

If you don’t provide a server name, you’ll be prompted to select from available OAuth-capable servers.

You can also list OAuth-capable servers and their authentication status.

codetutor mcp auth list

Or use the short version.

codetutor mcp auth ls

---

logout

Remove OAuth credentials for an MCP server.

codetutor mcp logout [name]

---

debug

Debug OAuth connection issues for an MCP server.

codetutor mcp debug <name>

---

models

List all available models from configured providers.

codetutor models [provider]

This command displays all models available across your configured providers in the format provider/model.

This is useful for figuring out the exact model name to use in your config.

You can optionally pass a provider ID to filter models by that provider.

codetutor models anthropic

Flags

Flag	Description
--refresh	Refresh the models cache from models.dev
--verbose	Use more verbose model output (includes metadata like costs)

Use the --refresh flag to update the cached model list. This is useful when new models have been added to a provider and you want to see them in CodeTutor.

codetutor models --refresh

---

run

Run codetutor in non-interactive mode by passing a prompt directly.

codetutor run [message..]

This is useful for scripting, automation, or when you want a quick answer without launching the full TUI. For example.

codetutor run Explain the use of context in Go

You can also attach to a running codetutor serve instance to avoid MCP server cold boot times on every run:

# Start a headless server in one terminal
codetutor serve

# In another terminal, run commands that attach to it
codetutor run --attach http://localhost:4096 "Explain async/await in JavaScript"

Flags

Flag	Short	Description
--command		The command to run, use message for args
--continue	-c	Continue the last session
--session	-s	Session ID to continue
--fork		Fork the session when continuing (use with --continue or --session)
--share		Share the session
--model	-m	Model to use in the form of provider/model
--agent		Agent to use
--file	-f	File(s) to attach to message
--format		Format: default (formatted) or json (raw JSON events)
--title		Title for the session (uses truncated prompt if no value provided)
--attach		Attach to a running codetutor server (e.g., http://localhost:4096)
--password	-p	Basic auth password (defaults to CODETUTOR_SERVER_PASSWORD)
--username	-u	Basic auth username (defaults to CODETUTOR_SERVER_USERNAME or codetutor)
--dir		Directory to run in, or path on the remote server when attaching
--port		Port for the local server (defaults to random port)
--variant		Model variant (provider-specific reasoning effort)
--thinking		Show thinking blocks
--auto		Auto-approve permissions that are not explicitly denied

---

serve

Start a headless CodeTutor server for API access. Check out the server docs for the full HTTP interface.

codetutor serve

This starts an HTTP server that provides API access to codetutor functionality without the TUI interface. Set CODETUTOR_SERVER_PASSWORD to enable HTTP basic auth (username defaults to codetutor).

Flags

Flag	Description
--port	Port to listen on
--hostname	Hostname to listen on
--mdns	Enable mDNS discovery
--mdns-domain	Custom mDNS domain name
--cors	Additional browser origin(s) to allow CORS

---

session

Manage CodeTutor sessions.

codetutor session [command]

---

list

List all CodeTutor sessions.

codetutor session list

Flags

Flag	Short	Description
--max-count	-n	Limit to N most recent sessions
--format		Output format: table or json (table)

---

delete

Delete an CodeTutor session.

codetutor session delete <sessionID>

---

stats

Show token usage and cost statistics for your CodeTutor sessions.

codetutor stats

Flags

Flag	Description
--days	Show stats for the last N days (all time)
--tools	Number of tools to show (all)
--models	Show model usage breakdown (hidden by default). Pass a number to show top N
--project	Filter by project (all projects, empty string: current project)

---

export

Export session data as JSON.

codetutor export [sessionID]

If you don’t provide a session ID, you’ll be prompted to select from available sessions.

Flags

Flag	Description
--sanitize	Redact sensitive transcript/file data

---

import

Import session data from a JSON file or CodeTutor share URL.

codetutor import <file>

You can import from a local file or an CodeTutor share URL.

codetutor import session.json
codetutor import https://opncd.ai/s/abc123

---

web

Start a headless CodeTutor server with a web interface.

codetutor web

This starts an HTTP server and opens a web browser to access CodeTutor through a web interface. Set CODETUTOR_SERVER_PASSWORD to enable HTTP basic auth (username defaults to codetutor).

Flags

Flag	Description
--port	Port to listen on
--hostname	Hostname to listen on
--mdns	Enable mDNS discovery
--mdns-domain	Custom mDNS domain name
--cors	Additional browser origin(s) to allow CORS

---

acp

Start an ACP (Agent Client Protocol) server.

codetutor acp

This command starts an ACP server that communicates via stdin/stdout using nd-JSON.

Flags

Flag	Description
--cwd	Working directory
--port	Port to listen on
--hostname	Hostname to listen on
--mdns	Enable mDNS discovery
--mdns-domain	Custom mDNS domain name
--cors	Additional browser origin(s) to allow CORS

---

plugin

Install a plugin and update your config.

codetutor plugin <module>

Or use the alias.

codetutor plug <module>

Flags

Flag	Short	Description
--global	-g	Install in global config
--force	-f	Replace existing plugin version

---

pr

Fetch and checkout a GitHub PR branch, then run CodeTutor.

codetutor pr <number>

---

db

Database tools.

codetutor db [query]

Flags

Flag	Description
--format	Output format: json or tsv

---

path

Print the database path.

codetutor db path

---

debug

Debugging and troubleshooting tools.

codetutor debug [command]

---

uninstall

Uninstall CodeTutor and remove all related files.

codetutor uninstall

Flags

Flag	Short	Description
--keep-config	-c	Keep configuration files
--keep-data	-d	Keep session data and snapshots
--dry-run		Show what would be removed without removing
--force	-f	Skip confirmation prompts

---

upgrade

Updates codetutor to the latest version or a specific version.

codetutor upgrade [target]

To upgrade to the latest version.

codetutor upgrade

To upgrade to a specific version.

codetutor upgrade v0.1.48

Flags

Flag	Short	Description
--method	-m	The installation method that was used; curl, npm, pnpm, bun, brew

---

Global Flags

The opencode CLI takes the following global flags.

Flag	Short	Description
--help	-h	Display help
--version	-v	Print version number
--print-logs		Print logs to stderr
--log-level		Log level (DEBUG, INFO, WARN, ERROR)
--pure		Run without external plugins

---

Environment variables

CodeTutor can be configured using environment variables.

Variable	Type	Description
CODETUTOR_AUTO_SHARE	boolean	Automatically share sessions
CODETUTOR_GIT_BASH_PATH	string	Path to Git Bash executable on Windows
CODETUTOR_CONFIG	string	Path to config file
CODETUTOR_TUI_CONFIG	string	Path to TUI config file
CODETUTOR_CONFIG_DIR	string	Path to config directory
CODETUTOR_CONFIG_CONTENT	string	Inline json config content
CODETUTOR_DISABLE_AUTOUPDATE	boolean	Disable automatic update checks
CODETUTOR_DISABLE_PRUNE	boolean	Disable pruning of old data
CODETUTOR_DISABLE_TERMINAL_TITLE	boolean	Disable automatic terminal title updates
CODETUTOR_PERMISSION	string	Inlined json permissions config
CODETUTOR_DISABLE_DEFAULT_PLUGINS	boolean	Disable default plugins
CODETUTOR_DISABLE_LSP_DOWNLOAD	boolean	Disable automatic LSP server downloads
CODETUTOR_ENABLE_EXPERIMENTAL_MODELS	boolean	Enable experimental models
CODETUTOR_DISABLE_AUTOCOMPACT	boolean	Disable automatic context compaction
CODETUTOR_DISABLE_CLAUDE_CODE	boolean	Disable reading from .claude (prompt + skills)
CODETUTOR_DISABLE_CLAUDE_CODE_PROMPT	boolean	Disable reading ~/.claude/CLAUDE.md
CODETUTOR_DISABLE_CLAUDE_CODE_SKILLS	boolean	Disable loading .claude/skills
CODETUTOR_DISABLE_MODELS_FETCH	boolean	Disable fetching models from remote sources
CODETUTOR_DISABLE_MOUSE	boolean	Disable mouse capture in the TUI
CODETUTOR_FAKE_VCS	string	Fake VCS provider for testing purposes
CODETUTOR_CLIENT	string	Client identifier (defaults to cli)
CODETUTOR_ENABLE_EXA	boolean	Enable Exa web search tools
CODETUTOR_SERVER_PASSWORD	string	Enable basic auth for serve/web
CODETUTOR_SERVER_USERNAME	string	Override basic auth username (default codetutor)
CODETUTOR_MODELS_URL	string	Custom URL for fetching models configuration

---

Experimental

These environment variables enable experimental features that may change or be removed.

Variable	Type	Description
CODETUTOR_EXPERIMENTAL	boolean	Enable the experimental umbrella flag
CODETUTOR_EXPERIMENTAL_ICON_DISCOVERY	boolean	Enable icon discovery
CODETUTOR_EXPERIMENTAL_DISABLE_COPY_ON_SELECT	boolean	Disable copy on select in TUI
CODETUTOR_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS	number	Default timeout for bash commands in ms
CODETUTOR_EXPERIMENTAL_OUTPUT_TOKEN_MAX	number	Max output tokens for LLM responses
CODETUTOR_EXPERIMENTAL_FILEWATCHER	boolean	Enable file watcher for entire dir
CODETUTOR_EXPERIMENTAL_OXFMT	boolean	Enable oxfmt formatter
CODETUTOR_EXPERIMENTAL_LSP_TOOL	boolean	Enable experimental LSP tool
CODETUTOR_EXPERIMENTAL_DISABLE_FILEWATCHER	boolean	Disable file watcher
CODETUTOR_EXPERIMENTAL_EXA	boolean	Enable experimental Exa features
CODETUTOR_EXPERIMENTAL_LSP_TY	boolean	Enable TY LSP for python files
CODETUTOR_EXPERIMENTAL_PLAN_MODE	boolean	Enable plan mode
CODETUTOR_EXPERIMENTAL_BACKGROUND_SUBAGENTS	boolean	Enable background subagent tasks
CODETUTOR_EXPERIMENTAL_EVENT_SYSTEM	boolean	Enable experimental event system
CODETUTOR_EXPERIMENTAL_NATIVE_LLM	boolean	Enable native LLM request path
CODETUTOR_EXPERIMENTAL_PARALLEL	boolean	Enable parallel web search execution
CODETUTOR_EXPERIMENTAL_SCOUT	boolean	Enable Scout subagent
CODETUTOR_EXPERIMENTAL_WORKSPACES	boolean	Enable workspace support