CLI
CLI opencode по умолчанию запускает TUI при запуске без каких-либо аргументов.
opencodeНо он также принимает команды, описанные на этой странице. Это позволяет вам программно взаимодействовать с opencode.
codetutor run "Explain how closures work in JavaScript"tui
Запустите TUI opencode.
opencode [project]Флаги
| Флаг | Короткий | Описание |
|---|---|---|
--continue | -c | Продолжить последний сеанс |
--session | -s | Идентификатор сеанса для продолжения |
--fork | Разветвить сеанс при продолжении (используйте с --continue или --session) | |
--prompt | Промпт для использования | |
--model | -m | Модель для использования в виде поставщика/модели. |
--agent | Агент для использования | |
--port | Порт для прослушивания | |
--hostname | Имя хоста для прослушивания |
Команды
CLI opencode также имеет следующие команды.
agent
Управляйте агентами для opencode.
codetutor agent [command]attach
Подключите терминал к уже работающему внутреннему серверу opencode, запущенному с помощью команд serve или web.
codetutor attach [url]Это позволяет использовать TUI с удаленным сервером opencode. Например:
# Start the backend server for web/mobile accesscodetutor web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backendcodetutor attach http://10.20.30.40:4096Флаги
| Флаг | Короткий | Описание |
|---|---|---|
--dir | Рабочий каталог для запуска TUI | |
--continue | -c | Продолжить последний сеанс |
--session | -s | Идентификатор сеанса для продолжения |
--fork | Создать ответвление сеанса при продолжении (используйте с --continue или --session) | |
--password | -p | Пароль базовой аутентификации (по умолчанию CODETUTOR_SERVER_PASSWORD) |
--username | -u | Имя пользователя базовой аутентификации (по умолчанию CODETUTOR_SERVER_USERNAME или codetutor) |
create
Создайте нового агента с пользовательской конфигурацией.
codetutor agent createЭта команда поможет вам создать новый агент с настраиваемой системной подсказкой и настройкой инструмента.
list
Перечислите всех доступных агентов.
codetutor agent listauth
Команда для управления учетными данными и входом в систему для провайдеров.
codetutor auth [command]login
opencode использует список провайдеров с Models.dev, поэтому вы можете использовать codetutor auth login для настройки ключей API для любого поставщика, которого вы хотите использовать. Это хранится в ~/.local/share/opencode/auth.json.
codetutor auth loginКогда opencode запускается, он загружает поставщиков из файла учетных данных. И если в ваших средах определены какие-либо ключи или файл .env в вашем проекте.
list
Перечисляет всех проверенных поставщиков, которые хранятся в файле учетных данных.
codetutor auth listИли короткая версия.
codetutor auth lslogout
Выключает вас из провайдера, удаляя его из файла учетных данных.
codetutor auth logoutgithub
Управляйте агентом GitHub для автоматизации репозитория.
codetutor github [command]install
Установите агент GitHub в свой репозиторий.
codetutor github installЭто настроит необходимый рабочий процесс GitHub Actions и проведет вас через процесс настройки. Подробнее.
run
Запустите агент GitHub. Обычно это используется в действиях GitHub.
codetutor github runФлаги
| Флаг | Описание |
|---|---|
--event | Имитирующее событие GitHub для запуска агента |
--token | Токен личного доступа GitHub |
mcp
Управляйте серверами протокола контекста модели.
codetutor mcp [command]add
Добавьте сервер MCP в свою конфигурацию.
codetutor mcp addЭта команда поможет вам добавить локальный или удаленный сервер MCP.
list
Перечислите все настроенные серверы MCP и состояние их подключения.
codetutor mcp listИли используйте короткую версию.
codetutor mcp lsauth
Аутентификация с помощью сервера MCP с поддержкой OAuth.
codetutor mcp auth [name]Если вы не укажете имя сервера, вам будет предложено выбрать один из доступных серверов с поддержкой OAuth.
Вы также можете перечислить серверы с поддержкой OAuth и их статус аутентификации.
codetutor mcp auth listИли используйте короткую версию.
codetutor mcp auth lslogout
Удалите учетные данные OAuth для сервера MCP.
codetutor mcp logout [name]debug
Отладка проблем с подключением OAuth для сервера MCP.
codetutor mcp debug <name>models
Перечислите все доступные модели от настроенных поставщиков.
codetutor models [provider]Эта команда отображает все модели, доступные у настроенных вами поставщиков, в формате provider/model.
Это полезно для определения точного названия модели, которое будет использоваться в вашем config.
При желании вы можете передать идентификатор поставщика, чтобы фильтровать модели по этому поставщику.
codetutor models anthropicФлаги
| Флаг | Описание |
|---|---|
--refresh | Обновите кеш моделей на сайте models.dev. |
--verbose | Используйте более подробный вывод модели (включая метаданные, такие как затраты). |
Используйте флаг --refresh для обновления списка кэшированных моделей. Это полезно, когда к поставщику добавлены новые модели и вы хотите увидеть их в opencode.
codetutor models --refreshrun
Запустите opencode в неинтерактивном режиме, передав приглашение напрямую.
codetutor run [message..]Это полезно для создания сценариев, автоматизации или когда вам нужен быстрый ответ без запуска полного TUI. Например.
codetutor run Explain the use of context in GoВы также можете подключиться к работающему экземпляру codetutor serve, чтобы избежать холодной загрузки сервера MCP при каждом запуске:
# Start a headless server in one terminalcodetutor serve
# In another terminal, run commands that attach to itcodetutor run --attach http://localhost:4096 "Explain async/await in JavaScript"Флаги
| Флаг | Короткий | Описание |
|---|---|---|
--command | Команда для запуска, используйте сообщение для аргументов | |
--continue | -c | Продолжить последний сеанс |
--session | -s | Идентификатор сеанса для продолжения |
--fork | Разветвить сеанс при продолжении (используйте с --continue или --session) | |
--share | Поделиться сеансом | |
--model | -m | Модель для использования в виде поставщика/модели. |
--agent | Агент для использования | |
--file | -f | Файл(ы) для прикрепления к сообщению |
--format | Формат: по умолчанию (отформатированный) или json (необработанные события JSON). | |
--title | Название сеанса (использует усеченное приглашение, если значение не указано) | |
--attach | Подключитесь к работающему серверу opencode (например, http://localhost:4096) | |
--password | -p | Пароль базовой аутентификации (по умолчанию CODETUTOR_SERVER_PASSWORD) |
--username | -u | Имя пользователя базовой аутентификации (по умолчанию CODETUTOR_SERVER_USERNAME или codetutor) |
--dir | Каталог для выполнения или путь на удалённом сервере при подключении | |
--variant | Вариант модели (уровень рассуждений для провайдера) | |
--thinking | Показать блоки размышлений | |
--port | Порт локального сервера (по умолчанию случайный порт) |
serve
Запустите автономный сервер opencode для доступа к API. Полный HTTP-интерфейс можно найти в server docs.
codetutor serveПри этом запускается HTTP-сервер, который обеспечивает доступ API к функциям opencode без интерфейса TUI. Установите CODETUTOR_SERVER_PASSWORD, чтобы включить базовую аутентификацию HTTP (имя пользователя по умолчанию — codetutor).
Флаги
| Флаг | Описание |
|---|---|
--port | Порт для прослушивания |
--hostname | Имя хоста для прослушивания |
--mdns | Включить обнаружение mDNS |
--cors | Дополнительные источники браузера, позволяющие разрешить CORS |
session
Управляйте сессиями opencode.
codetutor session [command]list
Перечислите все сеансы opencode.
codetutor session listФлаги
| Флаг | Короткий | Описание |
|---|---|---|
--max-count | -n | Ограничить N последних сеансов. |
--format | Формат вывода: таблица или json (таблица) |
stats
Покажите статистику использования токенов и затрат для ваших сеансов opencode.
codetutor statsФлаги
| Флаг | Описание |
|---|---|
--days | Показать статистику за последние N дней (все время) |
--tools | Количество инструментов для отображения (все) |
--models | Показать разбивку по использованию модели (по умолчанию скрыто). Передайте номер, чтобы показать верхнюю N |
--project | Фильтровать по проекту (все проекты, пустая строка: текущий проект) |
export
Экспортируйте данные сеанса в формате JSON.
codetutor export [sessionID]Если вы не укажете идентификатор сеанса, вам будет предложено выбрать один из доступных сеансов.
import
Импортируйте данные сеанса из файла JSON или URL-адреса общего ресурса opencode.
codetutor import <file>Вы можете импортировать из локального файла или URL-адреса общего ресурса opencode.
codetutor import session.jsoncodetutor import https://opncd.ai/s/abc123web
Запустите автономный сервер opencode с веб-интерфейсом.
codetutor webПри этом запускается HTTP-сервер и открывается веб-браузер для доступа к opencode через веб-интерфейс. Установите CODETUTOR_SERVER_PASSWORD, чтобы включить базовую аутентификацию HTTP (имя пользователя по умолчанию — codetutor).
Флаги
| Флаг | Описание |
|---|---|
--port | Порт для прослушивания |
--hostname | Имя хоста для прослушивания |
--mdns | Включить обнаружение mDNS |
--cors | Дополнительные источники браузера, позволяющие разрешить CORS |
acp
Запустите сервер ACP (агент-клиентский протокол).
codetutor acpЭта команда запускает сервер ACP, который обменивается данными через stdin/stdout с использованием nd-JSON.
Флаги
| Флаг | Описание |
|---|---|
--cwd | Рабочий каталог |
--port | Порт для прослушивания |
--hostname | Имя хоста для прослушивания |
uninstall
Удалите opencode и удалите все связанные файлы.
codetutor uninstallФлаги
| Флаг | Короткий | Описание |
|---|---|---|
--keep-config | -c | Сохраняйте файлы конфигурации |
--keep-data | -d | Храните данные сеанса и снимки |
--dry-run | Покажите, что было бы удалено без удаления | |
--force | -f | Пропустить запросы подтверждения |
upgrade
Обновляет opencode до последней версии или определенной версии.
codetutor upgrade [target]Чтобы обновиться до последней версии.
codetutor upgradeДля обновления до определенной версии.
codetutor upgrade v0.1.48Флаги
| Флаг | Короткий | Описание |
|---|---|---|
--method | -m | Используемый метод установки: local, npm, pnpm, bun, brew |
Глобальные флаги
CLI opencode принимает следующие глобальные флаги.
| Флаг | Короткий | Описание |
|---|---|---|
--help | -h | Отобразить справку |
--version | -v | Распечатать номер версии |
--print-logs | Печать журналов в stderr | |
--log-level | Уровень журнала (DEBUG, INFO, WARN, ERROR) |
Переменные среды
opencode можно настроить с помощью переменных среды.
| Переменная | Тип | Описание |
|---|---|---|
CODETUTOR_AUTO_SHARE | логическое значение | Автоматически делиться сеансами |
CODETUTOR_GIT_BASH_PATH | строка | Путь к исполняемому файлу Git Bash в Windows |
CODETUTOR_CONFIG | строка | Путь к файлу конфигурации |
CODETUTOR_TUI_CONFIG | строка | Путь к файлу конфигурации TUI |
CODETUTOR_CONFIG_DIR | строка | Путь к каталогу конфигурации |
CODETUTOR_CONFIG_CONTENT | строка | Встроенное содержимое конфигурации json |
CODETUTOR_DISABLE_AUTOUPDATE | логическое значение | Отключить автоматическую проверку обновлений |
CODETUTOR_DISABLE_PRUNE | логическое значение | Отключить удаление старых данных |
CODETUTOR_DISABLE_TERMINAL_TITLE | логическое значение | Отключить автоматическое обновление заголовка терминала |
CODETUTOR_PERMISSION | строка | Встроенная конфигурация разрешений json |
CODETUTOR_DISABLE_DEFAULT_PLUGINS | логическое значение | Отключить плагины по умолчанию |
CODETUTOR_DISABLE_LSP_DOWNLOAD | логическое значение | Отключить автоматическую загрузку LSP-сервера |
CODETUTOR_ENABLE_EXPERIMENTAL_MODELS | логическое значение | Включить экспериментальные модели |
CODETUTOR_DISABLE_AUTOCOMPACT | логическое значение | Отключить автоматическое сжатие контекста |
CODETUTOR_DISABLE_CLAUDE_CODE | логическое значение | Отключить чтение из .claude (подсказка + навыки) |
CODETUTOR_DISABLE_CLAUDE_CODE_PROMPT | логическое значение | Отключить чтение ~/.claude/CLAUDE.md |
CODETUTOR_DISABLE_CLAUDE_CODE_SKILLS | логическое значение | Отключить загрузку .claude/skills |
CODETUTOR_DISABLE_MODELS_FETCH | логическое значение | Отключить получение моделей из удаленных источников |
CODETUTOR_FAKE_VCS | строка | Поддельный поставщик VCS для целей тестирования |
CODETUTOR_CLIENT | строка | Идентификатор клиента (по умолчанию cli) |
CODETUTOR_ENABLE_EXA | логическое значение | Включить инструменты веб-поиска Exa |
CODETUTOR_SERVER_PASSWORD | строка | Включить базовую аутентификацию для serve/web |
CODETUTOR_SERVER_USERNAME | строка | Переопределить имя пользователя базовой аутентификации (по умолчанию codetutor) |
CODETUTOR_MODELS_URL | строка | Пользовательский URL-адрес для получения конфигурации модели |
Экспериментальные функции
Эти переменные среды позволяют использовать экспериментальные функции, которые могут быть изменены или удалены.
| Переменная | Тип | Описание |
|---|---|---|
CODETUTOR_EXPERIMENTAL | логическое значение | Включить экспериментальные функции под общим флагом |
CODETUTOR_EXPERIMENTAL_ICON_DISCOVERY | логическое значение | Включить обнаружение значков |
CODETUTOR_EXPERIMENTAL_DISABLE_COPY_ON_SELECT | логическое значение | Отключить копирование при выборе в TUI |
CODETUTOR_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS | число | Таймаут по умолчанию для команд bash в мс |
CODETUTOR_EXPERIMENTAL_OUTPUT_TOKEN_MAX | число | Максимальное количество токенов вывода для ответов LLM |
CODETUTOR_EXPERIMENTAL_FILEWATCHER | логическое значение | Включить просмотр файлов для всего каталога |
CODETUTOR_EXPERIMENTAL_OXFMT | логическое значение | Включить форматтер oxfmt |
CODETUTOR_EXPERIMENTAL_LSP_TOOL | логическое значение | Включить экспериментальный инструмент LSP |
CODETUTOR_EXPERIMENTAL_DISABLE_FILEWATCHER | логическое значение | Отключить просмотрщик файлов |
CODETUTOR_EXPERIMENTAL_EXA | логическое значение | Включить экспериментальные функции Exa |
CODETUTOR_EXPERIMENTAL_LSP_TY | логическое значение | Включить TY LSP для файлов python |
CODETUTOR_EXPERIMENTAL_PLAN_MODE | логическое значение | Включить режим плана |
CODETUTOR_EXPERIMENTAL_BACKGROUND_SUBAGENTS | логическое значение | Включить фоновые задачи субагентов |
CODETUTOR_EXPERIMENTAL_EVENT_SYSTEM | логическое значение | Включить экспериментальную систему событий |
CODETUTOR_EXPERIMENTAL_NATIVE_LLM | логическое значение | Включить нативный путь запросов LLM |
CODETUTOR_EXPERIMENTAL_PARALLEL | логическое значение | Включить параллельное выполнение веб-поиска |
CODETUTOR_EXPERIMENTAL_SCOUT | логическое значение | Включить субагент Scout |
CODETUTOR_EXPERIMENTAL_WORKSPACES | логическое значение | Включить поддержку рабочих областей |