docs: CLI docs for current commands and flags (#25399)
This commit is contained in:
OpeOginni
GitHub
parent
1ea6e6cd4b
commit
0d0ec7dc46
18 changed files with 1676 additions and 1413 deletions
|
|
@ -29,16 +29,16 @@ opencode [project]
|
|||
|
||||
#### Флаги
|
||||
|
||||
| Флаг | Короткий | Описание |
|
||||
| ------------ | -------- | ----------------------------------------------------------------------------- |
|
||||
| `--continue` | `-c` | Продолжить последний сеанс |
|
||||
| `--session` | `-s` | Идентификатор сеанса для продолжения |
|
||||
| `--fork` | | Разветвить сеанс при продолжении (используйте с `--continue` или `--session`) |
|
||||
| `--prompt` | | Промпт для использования |
|
||||
| `--model` | `-m` | Модель для использования в виде поставщика/модели. |
|
||||
| `--agent` | | Агент для использования |
|
||||
| `--port` | | Порт для прослушивания |
|
||||
| `--hostname` | | Имя хоста для прослушивания |
|
||||
| Флаг | Короткий | Описание |
|
||||
| ---------------------------------------- | -------- | ----------------------------------------------------------------------------- |
|
||||
| <nobr><code>{"--continue"}</code></nobr> | `-c` | Продолжить последний сеанс |
|
||||
| <nobr><code>{"--session"}</code></nobr> | `-s` | Идентификатор сеанса для продолжения |
|
||||
| <nobr><code>{"--fork"}</code></nobr> | | Разветвить сеанс при продолжении (используйте с `--continue` или `--session`) |
|
||||
| <nobr><code>{"--prompt"}</code></nobr> | | Промпт для использования |
|
||||
| <nobr><code>{"--model"}</code></nobr> | `-m` | Модель для использования в виде поставщика/модели. |
|
||||
| <nobr><code>{"--agent"}</code></nobr> | | Агент для использования |
|
||||
| <nobr><code>{"--port"}</code></nobr> | | Порт для прослушивания |
|
||||
| <nobr><code>{"--hostname"}</code></nobr> | | Имя хоста для прослушивания |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -78,10 +78,14 @@ opencode attach http://10.20.30.40:4096
|
|||
|
||||
#### Флаги
|
||||
|
||||
| Флаг | Короткий | Описание |
|
||||
| ----------- | -------- | ------------------------------------ |
|
||||
| `--dir` | | Рабочий каталог для запуска TUI |
|
||||
| `--session` | `-s` | Идентификатор сеанса для продолжения |
|
||||
| Флаг | Короткий | Описание |
|
||||
| ---------------------------------------- | -------- | ------------------------------------------------------------------------------------------------ |
|
||||
| <nobr><code>{"--dir"}</code></nobr> | | Рабочий каталог для запуска TUI |
|
||||
| <nobr><code>{"--continue"}</code></nobr> | `-c` | Продолжить последний сеанс |
|
||||
| <nobr><code>{"--session"}</code></nobr> | `-s` | Идентификатор сеанса для продолжения |
|
||||
| <nobr><code>{"--fork"}</code></nobr> | | Создать ответвление сеанса при продолжении (используйте с `--continue` или `--session`) |
|
||||
| <nobr><code>{"--password"}</code></nobr> | `-p` | Пароль базовой аутентификации (по умолчанию `OPENCODE_SERVER_PASSWORD`) |
|
||||
| <nobr><code>{"--username"}</code></nobr> | `-u` | Имя пользователя базовой аутентификации (по умолчанию `OPENCODE_SERVER_USERNAME` или `opencode`) |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -187,10 +191,10 @@ opencode github run
|
|||
|
||||
##### Флаги
|
||||
|
||||
| Флаг | Описание |
|
||||
| --------- | --------------------------------------------- |
|
||||
| `--event` | Имитирующее событие GitHub для запуска агента |
|
||||
| `--token` | Токен личного доступа GitHub |
|
||||
| Флаг | Описание |
|
||||
| ------------------------------------- | --------------------------------------------- |
|
||||
| <nobr><code>{"--event"}</code></nobr> | Имитирующее событие GitHub для запуска агента |
|
||||
| <nobr><code>{"--token"}</code></nobr> | Токен личного доступа GitHub |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -296,10 +300,10 @@ opencode models anthropic
|
|||
|
||||
#### Флаги
|
||||
|
||||
| Флаг | Описание |
|
||||
| ----------- | --------------------------------------------------------------------------------- |
|
||||
| `--refresh` | Обновите кеш моделей на сайте models.dev. |
|
||||
| `--verbose` | Используйте более подробный вывод модели (включая метаданные, такие как затраты). |
|
||||
| Флаг | Описание |
|
||||
| --------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| <nobr><code>{"--refresh"}</code></nobr> | Обновите кеш моделей на сайте models.dev. |
|
||||
| <nobr><code>{"--verbose"}</code></nobr> | Используйте более подробный вывод модели (включая метаданные, такие как затраты). |
|
||||
|
||||
Используйте флаг `--refresh` для обновления списка кэшированных моделей. Это полезно, когда к поставщику добавлены новые модели и вы хотите увидеть их в opencode.
|
||||
|
||||
|
|
@ -335,20 +339,25 @@ opencode 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) |
|
||||
| `--port` | | Порт локального сервера (по умолчанию случайный порт) |
|
||||
| Флаг | Короткий | Описание |
|
||||
| ---------------------------------------- | -------- | ------------------------------------------------------------------------------------------------ |
|
||||
| <nobr><code>{"--command"}</code></nobr> | | Команда для запуска, используйте сообщение для аргументов |
|
||||
| <nobr><code>{"--continue"}</code></nobr> | `-c` | Продолжить последний сеанс |
|
||||
| <nobr><code>{"--session"}</code></nobr> | `-s` | Идентификатор сеанса для продолжения |
|
||||
| <nobr><code>{"--fork"}</code></nobr> | | Разветвить сеанс при продолжении (используйте с `--continue` или `--session`) |
|
||||
| <nobr><code>{"--share"}</code></nobr> | | Поделиться сеансом |
|
||||
| <nobr><code>{"--model"}</code></nobr> | `-m` | Модель для использования в виде поставщика/модели. |
|
||||
| <nobr><code>{"--agent"}</code></nobr> | | Агент для использования |
|
||||
| <nobr><code>{"--file"}</code></nobr> | `-f` | Файл(ы) для прикрепления к сообщению |
|
||||
| <nobr><code>{"--format"}</code></nobr> | | Формат: по умолчанию (отформатированный) или json (необработанные события JSON). |
|
||||
| <nobr><code>{"--title"}</code></nobr> | | Название сеанса (использует усеченное приглашение, если значение не указано) |
|
||||
| <nobr><code>{"--attach"}</code></nobr> | | Подключитесь к работающему серверу opencode (например, http://localhost:4096) |
|
||||
| <nobr><code>{"--password"}</code></nobr> | `-p` | Пароль базовой аутентификации (по умолчанию `OPENCODE_SERVER_PASSWORD`) |
|
||||
| <nobr><code>{"--username"}</code></nobr> | `-u` | Имя пользователя базовой аутентификации (по умолчанию `OPENCODE_SERVER_USERNAME` или `opencode`) |
|
||||
| <nobr><code>{"--dir"}</code></nobr> | | Каталог для выполнения или путь на удалённом сервере при подключении |
|
||||
| <nobr><code>{"--variant"}</code></nobr> | | Вариант модели (уровень рассуждений для провайдера) |
|
||||
| <nobr><code>{"--thinking"}</code></nobr> | | Показать блоки размышлений |
|
||||
| <nobr><code>{"--port"}</code></nobr> | | Порт локального сервера (по умолчанию случайный порт) |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -364,12 +373,12 @@ opencode serve
|
|||
|
||||
#### Флаги
|
||||
|
||||
| Флаг | Описание |
|
||||
| ------------ | ------------------------------------------------------------- |
|
||||
| `--port` | Порт для прослушивания |
|
||||
| `--hostname` | Имя хоста для прослушивания |
|
||||
| `--mdns` | Включить обнаружение mDNS |
|
||||
| `--cors` | Дополнительные источники браузера, позволяющие разрешить CORS |
|
||||
| Флаг | Описание |
|
||||
| ---------------------------------------- | ------------------------------------------------------------- |
|
||||
| <nobr><code>{"--port"}</code></nobr> | Порт для прослушивания |
|
||||
| <nobr><code>{"--hostname"}</code></nobr> | Имя хоста для прослушивания |
|
||||
| <nobr><code>{"--mdns"}</code></nobr> | Включить обнаружение mDNS |
|
||||
| <nobr><code>{"--cors"}</code></nobr> | Дополнительные источники браузера, позволяющие разрешить CORS |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -393,10 +402,10 @@ opencode session list
|
|||
|
||||
##### Флаги
|
||||
|
||||
| Флаг | Короткий | Описание |
|
||||
| ------------- | -------- | ----------------------------------------- |
|
||||
| `--max-count` | `-n` | Ограничить N последних сеансов. |
|
||||
| `--format` | | Формат вывода: таблица или json (таблица) |
|
||||
| Флаг | Короткий | Описание |
|
||||
| ----------------------------------------- | -------- | ----------------------------------------- |
|
||||
| <nobr><code>{"--max-count"}</code></nobr> | `-n` | Ограничить N последних сеансов. |
|
||||
| <nobr><code>{"--format"}</code></nobr> | | Формат вывода: таблица или json (таблица) |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -410,12 +419,12 @@ opencode stats
|
|||
|
||||
#### Флаги
|
||||
|
||||
| Флаг | Описание |
|
||||
| ----------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| `--days` | Показать статистику за последние N дней (все время) |
|
||||
| `--tools` | Количество инструментов для отображения (все) |
|
||||
| `--models` | Показать разбивку по использованию модели (по умолчанию скрыто). Передайте номер, чтобы показать верхнюю N |
|
||||
| `--project` | Фильтровать по проекту (все проекты, пустая строка: текущий проект) |
|
||||
| Флаг | Описание |
|
||||
| --------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| <nobr><code>{"--days"}</code></nobr> | Показать статистику за последние N дней (все время) |
|
||||
| <nobr><code>{"--tools"}</code></nobr> | Количество инструментов для отображения (все) |
|
||||
| <nobr><code>{"--models"}</code></nobr> | Показать разбивку по использованию модели (по умолчанию скрыто). Передайте номер, чтобы показать верхнюю N |
|
||||
| <nobr><code>{"--project"}</code></nobr> | Фильтровать по проекту (все проекты, пустая строка: текущий проект) |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -460,12 +469,12 @@ opencode web
|
|||
|
||||
#### Флаги
|
||||
|
||||
| Флаг | Описание |
|
||||
| ------------ | ------------------------------------------------------------- |
|
||||
| `--port` | Порт для прослушивания |
|
||||
| `--hostname` | Имя хоста для прослушивания |
|
||||
| `--mdns` | Включить обнаружение mDNS |
|
||||
| `--cors` | Дополнительные источники браузера, позволяющие разрешить CORS |
|
||||
| Флаг | Описание |
|
||||
| ---------------------------------------- | ------------------------------------------------------------- |
|
||||
| <nobr><code>{"--port"}</code></nobr> | Порт для прослушивания |
|
||||
| <nobr><code>{"--hostname"}</code></nobr> | Имя хоста для прослушивания |
|
||||
| <nobr><code>{"--mdns"}</code></nobr> | Включить обнаружение mDNS |
|
||||
| <nobr><code>{"--cors"}</code></nobr> | Дополнительные источники браузера, позволяющие разрешить CORS |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -481,11 +490,11 @@ opencode acp
|
|||
|
||||
#### Флаги
|
||||
|
||||
| Флаг | Описание |
|
||||
| ------------ | --------------------------- |
|
||||
| `--cwd` | Рабочий каталог |
|
||||
| `--port` | Порт для прослушивания |
|
||||
| `--hostname` | Имя хоста для прослушивания |
|
||||
| Флаг | Описание |
|
||||
| ---------------------------------------- | --------------------------- |
|
||||
| <nobr><code>{"--cwd"}</code></nobr> | Рабочий каталог |
|
||||
| <nobr><code>{"--port"}</code></nobr> | Порт для прослушивания |
|
||||
| <nobr><code>{"--hostname"}</code></nobr> | Имя хоста для прослушивания |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -499,12 +508,12 @@ opencode uninstall
|
|||
|
||||
#### Флаги
|
||||
|
||||
| Флаг | Короткий | Описание |
|
||||
| --------------- | -------- | ------------------------------------------ |
|
||||
| `--keep-config` | `-c` | Сохраняйте файлы конфигурации |
|
||||
| `--keep-data` | `-d` | Храните данные сеанса и снимки |
|
||||
| `--dry-run` | | Покажите, что было бы удалено без удаления |
|
||||
| `--force` | `-f` | Пропустить запросы подтверждения |
|
||||
| Флаг | Короткий | Описание |
|
||||
| ------------------------------------------- | -------- | ------------------------------------------ |
|
||||
| <nobr><code>{"--keep-config"}</code></nobr> | `-c` | Сохраняйте файлы конфигурации |
|
||||
| <nobr><code>{"--keep-data"}</code></nobr> | `-d` | Храните данные сеанса и снимки |
|
||||
| <nobr><code>{"--dry-run"}</code></nobr> | | Покажите, что было бы удалено без удаления |
|
||||
| <nobr><code>{"--force"}</code></nobr> | `-f` | Пропустить запросы подтверждения |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -530,9 +539,9 @@ opencode upgrade v0.1.48
|
|||
|
||||
#### Флаги
|
||||
|
||||
| Флаг | Короткий | Описание |
|
||||
| ---------- | -------- | --------------------------------------------------------- |
|
||||
| `--method` | `-m` | Используемый метод установки: local, npm, pnpm, bun, brew |
|
||||
| Флаг | Короткий | Описание |
|
||||
| -------------------------------------- | -------- | --------------------------------------------------------- |
|
||||
| <nobr><code>{"--method"}</code></nobr> | `-m` | Используемый метод установки: local, npm, pnpm, bun, brew |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -540,12 +549,12 @@ opencode upgrade v0.1.48
|
|||
|
||||
CLI opencode принимает следующие глобальные флаги.
|
||||
|
||||
| Флаг | Короткий | Описание |
|
||||
| -------------- | -------- | ------------------------------------------ |
|
||||
| `--help` | `-h` | Отобразить справку |
|
||||
| `--version` | `-v` | Распечатать номер версии |
|
||||
| `--print-logs` | | Печать журналов в stderr |
|
||||
| `--log-level` | | Уровень журнала (DEBUG, INFO, WARN, ERROR) |
|
||||
| Флаг | Короткий | Описание |
|
||||
| ------------------------------------------ | -------- | ------------------------------------------ |
|
||||
| <nobr><code>{"--help"}</code></nobr> | `-h` | Отобразить справку |
|
||||
| <nobr><code>{"--version"}</code></nobr> | `-v` | Распечатать номер версии |
|
||||
| <nobr><code>{"--print-logs"}</code></nobr> | | Печать журналов в stderr |
|
||||
| <nobr><code>{"--log-level"}</code></nobr> | | Уровень журнала (DEBUG, INFO, WARN, ERROR) |
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue