백그라운드 실행 및 프로세스 도구

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

exec 도구

• command(필수)
• yieldMs(기본값 10000): 이 지연 시간 이후 자동으로 백그라운드 전환
• background(bool): 즉시 백그라운드 전환
• timeout(초, 기본값 tools.exec.timeoutSec): 이 시간 초과 후 프로세스를 종료합니다. 해당 호출에서 exec 프로세스 시간 초과만 비활성화하려면 timeout: 0을 설정하세요.
• elevated(bool): elevated 모드가 활성화/허용된 경우 샌드박스 외부에서 실행합니다(기본값은 gateway, exec 대상이 node이면 node).
• 실제 TTY가 필요한가요? pty: true를 설정하세요.
• workdir, env

• 포그라운드 실행은 출력을 직접 반환합니다.
• 백그라운드로 전환되면(명시적 전환 또는 시간 초과) 도구가 status: "running" + sessionId와 짧은 tail을 반환합니다.
• 백그라운드 및 yieldMs 실행은 호출에서 명시적 timeout을 제공하지 않는 한 tools.exec.timeoutSec를 상속합니다.
• 출력은 세션을 폴링하거나 지울 때까지 메모리에 유지됩니다.
• process 도구가 허용되지 않으면 exec는 동기적으로 실행되며 yieldMs/background를 무시합니다.
• 생성된 exec 명령은 컨텍스트 인식 셸/프로필 규칙을 위해 OPENCLAW_SHELL=exec를 받습니다.
• 지금 시작되는 장기 실행 작업의 경우 한 번만 시작하고, 활성화되어 있으며 명령이 출력을 내보내거나 실패할 때 자동 완료 깨우기에 의존하세요.
• 자동 완료 깨우기를 사용할 수 없거나, 출력 없이 정상 종료된 명령에 대해 조용한 성공 확인이 필요하면 process를 사용해 완료를 확인하세요.
• sleep 루프나 반복 폴링으로 리마인더 또는 지연된 후속 작업을 흉내 내지 마세요. 향후 작업에는 Cron을 사용하세요.

​

자식 프로세스 브리징

• PI_BASH_YIELD_MS: 기본 yield(ms)
• PI_BASH_MAX_OUTPUT_CHARS: 메모리 내 출력 한도(문자)
• OPENCLAW_BASH_PENDING_MAX_OUTPUT_CHARS: 스트림별 대기 중 stdout/stderr 한도(문자)
• PI_BASH_JOB_TTL_MS: 완료된 세션의 TTL(ms, 1분~3시간으로 제한)
• OPENCLAW_PROCESS_INPUT_WAIT_IDLE_MS: 쓰기 가능한 백그라운드 세션이 입력을 기다리는 것으로 표시되기 전의 유휴 출력 임계값(기본값 15000 ms)

• tools.exec.backgroundMs(기본값 10000)
• tools.exec.timeoutSec(기본값 1800)
• tools.exec.cleanupMs(기본값 1800000)
• tools.exec.notifyOnExit(기본값 true): 백그라운드로 전환된 exec가 종료되면 시스템 이벤트를 큐에 넣고 Heartbeat를 요청합니다.
• tools.exec.notifyOnExitEmptySuccess(기본값 false): true이면 출력이 없는 성공적인 백그라운드 실행에 대해서도 완료 이벤트를 큐에 넣습니다.

​

process 도구

• list: 실행 중 + 완료된 세션
• poll: 세션의 새 출력을 비웁니다(종료 상태도 보고).
• log: 집계된 출력을 읽고 입력 복구 힌트를 표시합니다(offset + limit 지원).
• write: stdin 전송(data, 선택적 eof)
• send-keys: PTY 기반 세션에 명시적 키 토큰 또는 바이트 전송
• submit: PTY 기반 세션에 Enter / 캐리지 리턴 전송
• paste: 리터럴 텍스트 전송, 선택적으로 bracketed paste 모드로 감쌈
• kill: 백그라운드 세션 종료
• clear: 완료된 세션을 메모리에서 제거
• remove: 실행 중이면 종료하고, 완료되었으면 지움

• 백그라운드로 전환된 세션만 메모리에 나열/유지됩니다.
• 프로세스가 다시 시작되면 세션은 손실됩니다(디스크 영속성 없음).
• 세션 로그는 process poll/log를 실행하고 도구 결과가 기록된 경우에만 채팅 기록에 저장됩니다.
• process는 에이전트별로 범위가 지정됩니다. 해당 에이전트가 시작한 세션만 볼 수 있습니다.
• 자동 완료 깨우기를 사용할 수 없을 때 상태, 로그, 조용한 성공 확인 또는 완료 확인에는 poll / log를 사용하세요.
• 대화형 CLI를 복구하기 전에 log를 사용해 현재 transcript, stdin 상태, 입력 대기 힌트를 함께 볼 수 있게 하세요.
• 입력 또는 개입이 필요할 때는 write / send-keys / submit / paste / kill을 사용하세요.
• process list에는 빠른 확인을 위한 파생 name(명령 동사 + 대상)이 포함됩니다.
• process list, poll, log는 세션에 아직 쓰기 가능한 stdin이 있고 입력 대기 임계값보다 오래 유휴 상태인 경우에만 waitingForInput을 보고합니다.
• process log는 줄 기반 offset/limit를 사용합니다.
• offset과 limit가 모두 생략되면 마지막 200줄을 반환하고 페이지 힌트를 포함합니다.
• offset이 제공되고 limit가 생략되면 offset부터 끝까지 반환합니다(200줄로 제한되지 않음).
• 폴링은 주문형 상태 확인용이지 wait-loop 예약용이 아닙니다. 작업을 나중에 수행해야 한다면 대신 Cron을 사용하세요.

​

예시

{ "tool": "exec", "command": "sleep 5 && echo done", "yieldMs": 1000 }

{ "tool": "process", "action": "poll", "sessionId": "<id>" }

{ "tool": "process", "action": "log", "sessionId": "<id>" }

{ "tool": "exec", "command": "npm run build", "background": true }

{ "tool": "process", "action": "write", "sessionId": "<id>", "data": "y\n" }

{ "tool": "process", "action": "send-keys", "sessionId": "<id>", "keys": ["C-c"] }

{ "tool": "process", "action": "submit", "sessionId": "<id>" }

{ "tool": "process", "action": "paste", "sessionId": "<id>", "text": "line1\nline2\n" }

​

관련 항목

• Exec 도구
• Exec 승인