Перейти к основному содержимому

CliRunnerEngine

CliRunnerEngine управляет жизненным циклом подпроцессов внешних CLI-инструментов агента (например, Claude Code CLI, Codex CLI) через ProcessSupervisor. Поддерживает как обычный режим подпроцесса, так и режим PTY-терминала.

Диаграмма архитектуры

graph TB
Router["AgentRouter / MagiService"] --> Engine["CliRunnerEngine"]

Engine --> Resolve["resolveCliConfig()"]
Engine --> Backend["resolveCliBackendConfig()"]
Engine --> Args["buildCliArgs()"]
Engine --> Env["buildEnv()"]

Engine --> Supervisor["ProcessSupervisor"]

Supervisor --> Decision{"Режим процесса?"}
Decision -->|"mode: 'child'"| ChildAdapter["ChildAdapter<br/>child_process.spawn"]
Decision -->|"mode: 'pty'"| PtyAdapter["PtyAdapter<br/>node-pty"]

ChildAdapter --> RunRegistry["RunRegistry<br/>отслеживание состояния запуска"]
PtyAdapter --> RunRegistry

Engine --> Parse["parseCliOutput()"]
Engine --> DB["Сохранение в БД<br/>сообщения + ID сессии"]
Engine --> IPC["IPC-события<br/>agent:event"]

ProcessSupervisor

ProcessSupervisor — менеджер жизненного цикла подпроцессов.

Интерфейс

interface ProcessSupervisor {
spawn(input: SpawnInput): ManagedRun;
cancel(runId: string, reason?: TerminationReason): void;
cancelScope(scopeKey: string, reason?: TerminationReason): void;
getRecord(runId: string): RunRecord | undefined;
resizePty(runId: string, cols: number, rows: number): boolean;
}

Режимы процессов

Режим Child

interface SpawnChildInput {
mode: 'child';
argv: string[]; // команда и аргументы
input?: string; // ввод в stdin
stdinMode?: 'inherit' | 'pipe-open' | 'pipe-closed';
windowsVerbatimArguments?: boolean;
// ...общие поля
}

Использует child_process.spawn для создания подпроцесса с обменом данными через stdin/stdout по каналам (pipes).

Режим PTY

interface SpawnPtyInput {
mode: 'pty';
shell?: string; // по умолчанию: powershell.exe (Windows) / /bin/bash (Unix)
args?: string[];
cols?: number; // по умолчанию 120
rows?: number; // по умолчанию 30
// ...общие поля
}

Использует node-pty для создания псевдотерминала с полной интерактивностью (цвета, курсор, редактирование строки).

ManagedRun

interface ManagedRun {
runId: string;
pid?: number;
startedAtMs: number;
stdin?: ManagedRunStdin;
wait: () => Promise<RunExit>;
cancel: (reason?: TerminationReason) => void;
}

interface RunExit {
reason: TerminationReason;
exitCode: number | null;
exitSignal: string | null;
durationMs: number;
stdout: string;
stderr: string;
timedOut: boolean;
noOutputTimedOut: boolean;
}

Причины завершения

type TerminationReason =
| 'manual-cancel' // ручная отмена пользователем
| 'overall-timeout' // таймаут общего времени выполнения
| 'no-output-timeout' // таймаут отсутствия вывода
| 'spawn-error' // ошибка запуска
| 'signal' // получен сигнал
| 'exit'; // нормальное завершение

Состояние запуска

type RunState = 'starting' | 'running' | 'exiting' | 'exited';

interface RunRecord {
runId: string;
sessionId: string;
backendId: string;
scopeKey?: string;
pid?: number;
startedAtMs: number;
lastOutputAtMs: number;
state: RunState;
terminationReason?: TerminationReason;
exitCode?: number | null;
}

Управление областями (Scope)

scopeKey группирует процессы; процессы в одной области можно отменить пакетно:

scopeKey = `cli:${backendId}:${cliSessionId}`
replaceExistingScope = true // новый процесс автоматически отменяет старые в той же области

Обработка таймаутов

Двойной механизм таймаутов:

  1. Общий таймаут (timeoutMs) — ограничение общего времени выполнения процесса
  2. Таймаут отсутствия вывода (noOutputTimeoutMs) — ограничение времени простоя процесса
graph LR
Start["Запуск процесса"] --> Timer1["Таймер общего времени<br/>по умолчанию 300 с"]
Start --> Timer2["Таймер отсутствия вывода<br/>динамический расчёт"]

Timer1 -->|таймаут| Kill1["завершить: overall-timeout"]
Timer2 -->|таймаут| Kill2["завершить: no-output-timeout"]

Output["получен вывод"] -->|сбросить| Timer2

Расчёт таймаута отсутствия вывода (cli-watchdog):

noOutputTimeoutMs = clamp(
overallTimeoutMs * ratio,
minMs,
maxMs,
)
ПараметрПервый запуск (Fresh)Возобновление (Resume)
ratio0.80.3
minMs180 000 (3 мин)60 000 (1 мин)
maxMs600 000 (10 мин)180 000 (3 мин)

Кроссплатформенное завершение процессов

kill-tree.ts обеспечивает кроссплатформенное завершение дерева процессов:

  • Windowstaskkill /F /T /PID (принудительное завершение дерева процессов)
  • Unix — сигналы группе процессов: SIGTERM → ожидание → SIGKILL

CLI-бэкенды

Встроенные бэкенды

Claude Code CLI

{
command: 'claude',
args: ['--output-format', 'json', '--verbose', '--max-turns', '25'],
resumeArgs: ['--output-format', 'json', '--verbose', '--resume', '{sessionId}'],
output: 'json',
input: 'arg',
modelArg: '--model',
sessionArg: '--session-id',
sessionMode: 'always',
}

Codex CLI

{
command: 'codex',
args: ['exec', '--json', '--color', 'never', '--sandbox', 'workspace-write', '--skip-git-repo-check'],
output: 'jsonl',
input: 'arg',
modelArg: '--model',
sessionMode: 'none',
}

Разрешение конфигурации бэкенда

function resolveCliBackendConfig(
backendId: string,
overrides?: Partial<CliBackendConfig>,
): ResolvedCliBackend | null;
  1. Найти встроенную конфигурацию по backendId
  2. Применить пользовательские переопределения
  3. Вернуть объединённую конфигурацию

Построение аргументов CLI

function buildCliArgs(options: {
backend: CliBackendConfig;
baseArgs: string[];
modelId?: string;
sessionId?: string;
systemPrompt?: string;
isResume: boolean;
}): string[];

Объединяются по порядку: baseArgs--model--session-id--append-system-prompt

Разбор вывода

function parseCliOutput(
stdout: string,
outputMode: 'json' | 'jsonl' | 'text',
sessionIdFields?: string[],
): { text: string; sessionId?: string; usage?: object };
Режим выводаСтратегия разбора
jsonРазобрать весь вывод как JSON, извлечь поле result или text
jsonlРазобрать строки JSON, объединить содержимое
textИспользовать сырой текст напрямую

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

ID CLI-сессии

CliRunnerEngine поддерживает ID сессии для CLI-инструментов с поддержкой многоходовых диалогов:

sessionMode: 'always' | 'existing' | 'none'
РежимПоведение
alwaysвсегда использовать ID сессии (генерировать новый, если отсутствует)
existingиспользовать только существующий ID сессии
noneне использовать ID сессии

ID сессии хранится в поле chatSessions.cliSessionIds (сгруппировано по backendId).

PTY-терминал

В режиме PTY данные терминала транслируются в реальном времени во все окна renderer:

IPC-событиеПолезная нагрузкаОписание
cli:ptyData{ sessionId, data }выходные данные терминала
cli:ptyExit{ sessionId, exitCode, reason }завершение процесса терминала

Поддерживается изменение размера терминала:

resizePty(dbSessionId: string, cols: number, rows: number): boolean;

IPC-события

СобытиеОписание
agent:event type=userMessageсообщение пользователя сохранено
agent:event type=processingвыполняется CLI-команда
agent:event type=assistantMessageвывод CLI сохранён
agent:event type=resultстатистика результата выполнения
agent:event type=errorсообщение об ошибке
cli:ptyDataпоток данных PTY-терминала
cli:ptyExitзавершение PTY-процесса

Ключевые файлы

ФайлПутьОписание
CliRunnerEngineagent-core/engine/cli/CliRunnerEngine.tsреализация IEngine
cli-backendsagent-core/engine/cli/cli-backends.tsвстроенные конфигурации бэкендов и их разрешение
cli-helpersagent-core/engine/cli/cli-helpers.tsпостроение аргументов и разбор вывода
cli-watchdogagent-core/engine/cli/cli-watchdog.tsрасчёт таймаута отсутствия вывода
cli/indexagent-core/engine/cli/index.tsэкспорт модуля
supervisorprocess/supervisor/supervisor.tsреализация ProcessSupervisor
child-adapterprocess/supervisor/child-adapter.tsадаптер дочернего процесса
pty-adapterprocess/supervisor/pty-adapter.tsPTY-адаптер
kill-treeprocess/supervisor/kill-tree.tsкроссплатформенное завершение процессов
run-registryprocess/supervisor/run-registry.tsреестр состояний запусков
typesprocess/supervisor/types.tsопределения типов
CliEngineConfig@shared/contracts/cli-types.tsобщие типы

Все пути указаны относительно packages/desktop/app/main/services/.

Точки расширения

  • Новый CLI-бэкенд: добавить новый CliBackendConfig в cli-backends.ts
  • Пользовательский разбор вывода: добавить новый формат в parseCliOutput в cli-helpers.ts
  • Пользовательская стратегия таймаутов: изменить CLI_FRESH_WATCHDOG_DEFAULTS / CLI_RESUME_WATCHDOG_DEFAULTS

Связанные модули

МодульПутьСвязь
EngineDispatcheragent-core/engine/EngineDispatcher.tsрегистрация движка
ProcessSupervisorprocess/supervisor/управление подпроцессами
MagiServiceagent-core/magi/MagiService.tsвысокоуровневая оркестрация