CLI

Параметры и команды CLI OpenCode.

CLI OpenCode по умолчанию запускает TUI при запуске без аргументов.

opencode

Но он также принимает команды, описанные на этой странице. Это позволяет взаимодействовать с OpenCode программно.

opencode run "Explain how closures work in JavaScript"

tui

Запуск терминального пользовательского интерфейса OpenCode.

opencode [project]

Флаги

Команды

CLI OpenCode также имеет следующие команды.

agent

Управление агентами для OpenCode.

opencode agent [command]

create

Создание нового агента с пользовательской конфигурацией.

opencode agent create

Эта команда проведёт вас через создание нового агента с пользовательским системным промптом и конфигурацией разрешений. Всё, что вы не разрешаете, запрещается во frontmatter сгенерированного агента.

Флаги

Передача всех флагов --path, --description, --mode и --permissions запускает команду в неинтерактивном режиме.

list

Список всех доступных агентов.

opencode agent list

attach

Подключение терминала к уже запущенному backend-серверу OpenCode, запущенному через команды serve или web.

opencode attach [url]

Это позволяет использовать TUI с удалённым backend OpenCode. Например:

# Запустить backend-сервер для веб/мобильного доступа
opencode web --port 4096 --hostname 0.0.0.0
 
# В другом терминале подключить TUI к работающему backend
opencode attach http://10.20.30.40:4096

Флаги

auth

Команда для управления учётными данными и входом для провайдеров.

opencode auth [command]

login

OpenCode работает на основе списка провайдеров на Models.dev (opens in a new tab), поэтому вы можете использовать opencode auth login для настройки API-ключей для любого провайдера, который хотите использовать. Это сохраняется в ~/.local/share/opencode/auth.json.

opencode auth login

При запуске OpenCode загружает провайдеров из файла учётных данных. А также если есть ключи, определённые в вашем окружении или файле .env в вашем проекте.

Флаги

list

Перечисляет всех аутентифицированных провайдеров, как они хранятся в файле учётных данных.

opencode auth list

Или короткая версия.

opencode auth ls

logout

Выполняет выход из провайдера, очищая его из файла учётных данных.

opencode auth logout

github

Управление агентом GitHub для автоматизации репозитория.

opencode github [command]

install

Установка агента GitHub в вашем репозитории.

opencode github install

Это настраивает необходимый рабочий процесс GitHub Actions и проводит вас через процесс конфигурации. Подробнее.

run

Запуск агента GitHub. Обычно используется в GitHub Actions.

opencode github run

Флаги

mcp

Управление серверами Model Context Protocol.

opencode mcp [command]

add

Добавление MCP сервера в вашу конфигурацию.

opencode mcp add

Эта команда проведёт вас через добавление локального или удалённого MCP сервера.

list

Список всех настроенных MCP серверов и их статуса подключения.

opencode mcp list

Или используйте короткую версию.

opencode mcp ls

auth

Аутентификация с MCP сервером, поддерживающим OAuth.

opencode mcp auth [name]

Если вы не укажете имя сервера, вам будет предложено выбрать из доступных серверов с поддержкой OAuth.

Вы также можете перечислить серверы с поддержкой OAuth и их статус аутентификации.

opencode mcp auth list

Или используйте короткую версию.

opencode mcp auth ls

logout

Удаление учётных данных OAuth для MCP сервера.

opencode mcp logout [name]

debug

Отладка проблем подключения OAuth для MCP сервера.

opencode mcp debug <name>

models

Список всех доступных моделей от настроенных провайдеров.

opencode models [provider]

Эта команда отображает все модели, доступные у ваших настроенных провайдеров, в формате provider/model.

Это полезно для определения точного имени модели для использования в вашей конфигурации.

Вы можете опционально передать ID провайдера для фильтрации моделей по этому провайдеру.

opencode models anthropic

Флаги

Используйте флаг --refresh для обновления кэшированного списка моделей. Это полезно, когда новые модели были добавлены к провайдеру и вы хотите увидеть их в OpenCode.

opencode models --refresh

run

Запуск opencode в неинтерактивном режиме путём передачи промпта напрямую.

opencode run [message..]

Это полезно для скриптинга, автоматизации или когда вы хотите получить быстрый ответ без запуска полного TUI. Например.

opencode run Explain the use of context in Go

Вы также можете подключиться к работающему экземпляру opencode serve, чтобы избежать времени холодного запуска MCP серверов при каждом запуске:

# Запустить headless-сервер в одном терминале
opencode serve
 
# В другом терминале запускать команды, подключающиеся к нему
opencode run --attach http://localhost:4096 "Explain async/await in JavaScript"

Флаги

serve

Запуск headless-сервера OpenCode для доступа через API. Смотрите документацию сервера для полного HTTP-интерфейса.

opencode serve

Это запускает HTTP-сервер, который предоставляет доступ через API к функциональности opencode без интерфейса TUI. Установите OPENCODE_SERVER_PASSWORD, чтобы включить HTTP basic auth (имя пользователя по умолчанию opencode).

Флаги

session

Управление сессиями OpenCode.

opencode session [command]

list

Список всех сессий OpenCode.

opencode session list

Флаги

delete

Удаление сессии OpenCode.

opencode session delete <sessionID>

stats

Показать статистику использования токенов и стоимости для ваших сессий OpenCode.

opencode stats

Флаги

export

Экспорт данных сессии в формате JSON.

opencode export [sessionID]

Если вы не укажете ID сессии, вам будет предложено выбрать из доступных сессий.

Флаги

import

Импорт данных сессии из JSON-файла или URL для общего доступа OpenCode.

opencode import <file>

Вы можете импортировать из локального файла или URL для общего доступа OpenCode.

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

web

Запуск headless-сервера OpenCode с веб-интерфейсом.

opencode web

Это запускает HTTP-сервер и открывает веб-браузер для доступа к OpenCode через веб-интерфейс. Установите OPENCODE_SERVER_PASSWORD, чтобы включить HTTP basic auth (имя пользователя по умолчанию opencode).

Флаги

acp

Запуск ACP (Agent Client Protocol) сервера.

opencode acp

Эта команда запускает ACP сервер, который взаимодействует через stdin/stdout, используя nd-JSON.

Флаги

plugin

Установка плагина и обновление вашей конфигурации.

opencode plugin <module>

Или используйте псевдоним.

opencode plug <module>

Флаги

pr

Получение и checkout ветки GitHub PR, затем запуск OpenCode.

opencode pr <number>

db

Инструменты базы данных.

opencode db [query]

Флаги

path

Вывести путь к базе данных.

opencode db path

debug

Инструменты отладки и устранения неполадок.

opencode debug [command]

uninstall

Удаление OpenCode и всех связанных файлов.

opencode uninstall

Флаги

upgrade

Обновляет opencode до последней версии или конкретной версии.

opencode upgrade [target]

Чтобы обновить до последней версии.

opencode upgrade

Чтобы обновить до конкретной версии.

opencode upgrade v0.1.48

Флаги

Глобальные флаги

CLI opencode принимает следующие глобальные флаги.

Переменные окружения

OpenCode можно настроить с помощью переменных окружения.

Экспериментальные

Эти переменные окружения включают экспериментальные функции, которые могут измениться или быть удалены.