Logbook plugin

Logbook plugin 문서는 OpenClaw 공식 문서(plugins/logbook)를 한국어로 정리한 가이드입니다. Optional automatic work journal built from periodic screen snapshots 명령·설정 키·코드 예시는 공식 문서를 그대로 보존하며, 해석과 절차 안내는 한국어로 제공합니다. 최종 동작은 설치된 CLI 버전과 공식 원문을 확인하세요.

핵심 요약

Optional automatic work journal built from periodic screen snapshots

한국어 가이드 범위: plugins/logbook 경로의 설정·명령·제약·예시를 학습용으로 재구성합니다.

문서 구성

공식 문서의 주요 섹션은 다음과 같습니다.

시작하기 전에
Quickstart
동작 방식
Model and data flow
구성
Vision model selection
Dashboard tab
Gateway methods
Privacy notes
트러블슈팅
The Logbook tab is missing
Capture reports an error
Captures succeed but no cards appear
관련 문서

상세 내용

본문

The Logbook plugin turns screen activity into an automatic work journal. It captures periodic screen snapshots from a paired node, summarizes them into timestamped observations, and builds timeline cards in the Control UI. It can also generate daily standup notes and answer questions about a tracked day.

시작하기 전에

macOS app node needs Screen Recording permission. A headless macOS node host (openclaw node host run) gets the plugin-provided logbook.snapshot command backed by the system screencapture tool.

주요 항목:

A connected node that exposes screen.snapshot or logbook.snapshot. The
The bundled Codex plugin enabled and authenticated. Codex currently provides
A working default agent model. Logbook uses it to synthesize cards, standup

Quickstart

Configure an explicit vision model for deterministic startup:

openclaw plugins enable codex
openclaw plugins enable logbook

{
  plugins: {
    entries: {
      codex: {
        enabled: true,
      },
      logbook: {
        enabled: true,
        config: {
          visionModel: "codex/gpt-5.6-sol",
        },
      },
    },
  },
}

openclaw gateway restart
openclaw plugins inspect logbook --runtime --json
openclaw nodes status --connected
openclaw nodes describe --node <idOrNameOrIp>
openclaw dashboard

동작 방식

Capture: every captureIntervalSeconds (default 30s), Logbook invokes the selected node's capture command and stores a scaled JPEG frame. Consecutive identical frames are marked idle and excluded from analysis. 2. Observe: once an analysis window (default 15 minutes) elapses, the plugin samples up to 16 active frames and sends them to the vision model, which returns timestamped activity observations ("VS Code: editing store.ts, fixing a type error"). A capture gap longer than two minutes or local midnight also closes the current window. 3. Synthesize: observations plus the last 45 minutes of existing cards are revised into timeline cards (10-60 minutes each) with a title, summary, category, main app, and any brief distractions. 4. Prune: frames older than retentionDays (default 14) are deleted. Cards, observations, and cached standups are kept.

Model and data flow

The full SQLite database is not sent to either model. Raw screenshots go only to the observation stage; card synthesis, standup, and Q&A receive derived text.

Stage	Data sent	Model route
Observe	Up to 16 sampled JPEG frames plus their capture times	`visionModel`, or a compatible borrowed `tools.media` Codex entry
Synthesize cards	Timestamped observations and recent timeline cards	Default agent model through the plugin LLM runtime
Generate standup	Cards for the selected day and previous day	Default agent model through the plugin LLM runtime
Ask your day	The question, selected-day cards, and recent observations	Default agent model through the plugin LLM runtime

구성

All Logbook config keys are optional. Numeric values are rounded to integers and clamped to the supported range.

Key	Default	Range or values	Behavior
`captureEnabled`	`true`	boolean	Persistent master switch for new snapshots; the timeline remains available when `false`
`captureIntervalSeconds`	`30`	`5`-`600`	Delay between capture attempts
`analysisIntervalMinutes`	`15`	`3`-`120`	Target observation window; gaps and midnight can close it earlier
`nodeId`	unset	node id or display name	Pins capture to one connected node; matching is case-insensitive
`screenIndex`	`0`	`0`-`16`	Zero-based display index
`maxWidth`	`1440`	`480`-`3840`	Requested capture size cap; headless macOS applies it to the largest dimension
`visionModel`	unset	`provider/model`	Explicit structured route; malformed refs pause analysis, unsupported providers fail batches
`retentionDays`	`14`	`1`-`365`	Deletes old frames; cards, observations, and standups remain

{
  plugins: {
    entries: {
      codex: {
        enabled: true,
      },
      logbook: {
        enabled: true,
        config: {
          captureEnabled: true,
          captureIntervalSeconds: 30,
          analysisIntervalMinutes: 15,
          nodeId: "my-mac",
          screenIndex: 0,
          maxWidth: 1440,
          visionModel: "codex/gpt-5.6-sol",
          retentionDays: 14,
        },
      },
    },
  },
}

Vision model selection

Logbook resolves the observation model in this order:

Dashboard tab

app, distraction chips, and a snapshot keyframe.

주요 항목:

Timeline: expandable cards per activity with category colors, the main
Day at a glance: focus ratio, category breakdown, top apps.
Daily standup: turns yesterday plus today into a ready-to-paste update.
Ask your day: natural-language questions answered from the tracked
Analyze now: closes the current capture window immediately instead of

Gateway methods

Logbook registers these Gateway RPC methods:

Method	Parameters	Scope	Result
`logbook.status`	none	`operator.read`	Capture, analysis, model, node, Gateway day, and Gateway timezone status
`logbook.days`	none	`operator.read`	Days with timeline-card counts and card time bounds
`logbook.timeline`	`{ day?: "YYYY-MM-DD" }`	`operator.read`	Derived cards and day statistics; defaults to the Gateway's current day
`logbook.frames`	`{ startMs, endMs }`	`operator.write`	Frame metadata in the requested epoch-millisecond range
`logbook.frame`	`{ frameId }`	`operator.write`	One raw JPEG frame as base64
`logbook.standup`	`{ day?, refresh? }`	`operator.write`	Cached or regenerated standup text for a day
`logbook.ask`	`{ day?, question }`	`operator.write`	Timeline-grounded answer for a day
`logbook.capture.set`	`{ paused }`	`operator.write`	Session-only pause state and updated status
`logbook.analyze.now`	none	`operator.write`	Starts pending analysis, or returns a reason it could not start

Privacy notes

leave the machine except as sampled input to the configured observation model.

주요 항목:

Snapshots can contain anything on screen, including secrets. Frames never
Observations, recent cards, and questions can leave the machine through the
Use local routes for both the structured observation model and default agent
Frames, the timeline database, and temporary captures are written with
Adding screen.snapshot to gateway.nodes.commands.deny is the
Setting tools.media.image.enabled: false also stops Logbook from borrowing

트러블슈팅

이 섹션의 세부 항목은 공식 문서 트러블슈팅를 참고하세요.

The Logbook tab is missing

openclaw plugins list --enabled includes logbook. 2. The Gateway restarted after the plugin or allowlist change. 3. The Control UI connection has operator.write; read-only sessions do not receive the interactive tab descriptor.

Capture reports an error

After three consecutive failures, Logbook backs off for ten capture ticks and then retries. An unpinned setup can rotate to another eligible node.

주요 항목:

Confirm the node exposes screen.snapshot or logbook.snapshot.
Grant Screen Recording permission on the capture Mac.
If nodeId is configured, confirm it matches the node id or display name.
Check that gateway.nodes.commands.deny does not contain

openclaw nodes status --connected
openclaw nodes describe --node <idOrNameOrIp>
openclaw logs --follow

Captures succeed but no cards appear

found. Enable and authenticate the Codex plugin, or set a valid explicit visionModel. Captured frames remain pending while the model is missing and can be analyzed after configuration is fixed.

주요 항목:

A Model missing status means no compatible structured vision route was
Wait for analysisIntervalMinutes, or select Analyze now after activity
Consecutive identical frames are idle evidence and do not enter analysis
If the latest batch shows an error, fix the model or auth problem and select

실습 체크리스트

공식 문서와 로컬 버전을 대조합니다: https://docs.openclaw.ai/plugins/logbook
관련 CLI는 openclaw --help 및 하위 명령 --help로 옵션을 확인합니다.
설정 변경 시 openclaw config / openclaw doctor로 유효성을 검사합니다.
Gateway·채널·플러그인 변경 후에는 필요 시 Gateway를 재시작합니다.

자주 쓰는 명령·설정 예시

openclaw plugins enable codex
openclaw plugins enable logbook

{
  plugins: {
    entries: {
      codex: {
        enabled: true,
      },
      logbook: {
        enabled: true,
        config: {
          visionModel: "codex/gpt-5.6-sol",
        },
      },
    },
  },
}

openclaw gateway restart
openclaw plugins inspect logbook --runtime --json
openclaw nodes status --connected
openclaw nodes describe --node <idOrNameOrIp>
openclaw dashboard

{
  plugins: {
    entries: {
      codex: {
        enabled: true,
      },
      logbook: {
        enabled: true,
        config: {
          captureEnabled: true,
          captureIntervalSeconds: 30,
          analysisIntervalMinutes: 15,
          nodeId: "my-mac",
          screenIndex: 0,
          maxWidth: 1440,
          visionModel: "codex/gpt-5.6-sol",
          retentionDays: 14,
        },
      },
    },
  },
}

openclaw nodes status --connected
openclaw nodes describe --node <idOrNameOrIp>
openclaw logs --follow

Logbook plugin

핵심 요약

Optional automatic work journal built from periodic screen snapshots

한국어 가이드 범위: plugins/logbook 경로의 설정·명령·제약·예시를 학습용으로 재구성합니다.

문서 구성

공식 문서의 주요 섹션은 다음과 같습니다.

시작하기 전에
Quickstart
동작 방식
Model and data flow
구성
Vision model selection
Dashboard tab
Gateway methods
Privacy notes
트러블슈팅
The Logbook tab is missing
Capture reports an error
Captures succeed but no cards appear
관련 문서

상세 내용

본문

시작하기 전에

macOS app node needs Screen Recording permission. A headless macOS node host (openclaw node host run) gets the plugin-provided logbook.snapshot command backed by the system screencapture tool.

주요 항목:

A connected node that exposes screen.snapshot or logbook.snapshot. The
The bundled Codex plugin enabled and authenticated. Codex currently provides
A working default agent model. Logbook uses it to synthesize cards, standup

Quickstart

Configure an explicit vision model for deterministic startup:

openclaw plugins enable codex
openclaw plugins enable logbook

{
  plugins: {
    entries: {
      codex: {
        enabled: true,
      },
      logbook: {
        enabled: true,
        config: {
          visionModel: "codex/gpt-5.6-sol",
        },
      },
    },
  },
}

openclaw gateway restart
openclaw plugins inspect logbook --runtime --json
openclaw nodes status --connected
openclaw nodes describe --node <idOrNameOrIp>
openclaw dashboard

동작 방식

Capture: every captureIntervalSeconds (default 30s), Logbook invokes the selected node's capture command and stores a scaled JPEG frame. Consecutive identical frames are marked idle and excluded from analysis. 2. Observe: once an analysis window (default 15 minutes) elapses, the plugin samples up to 16 active frames and sends them to the vision model, which returns timestamped activity observations ("VS Code: editing store.ts, fixing a type error"). A capture gap longer than two minutes or local midnight also closes the current window. 3. Synthesize: observations plus the last 45 minutes of existing cards are revised into timeline cards (10-60 minutes each) with a title, summary, category, main app, and any brief distractions. 4. Prune: frames older than retentionDays (default 14) are deleted. Cards, observations, and cached standups are kept.

Model and data flow

The full SQLite database is not sent to either model. Raw screenshots go only to the observation stage; card synthesis, standup, and Q&A receive derived text.

Stage	Data sent	Model route
Observe	Up to 16 sampled JPEG frames plus their capture times	`visionModel`, or a compatible borrowed `tools.media` Codex entry
Synthesize cards	Timestamped observations and recent timeline cards	Default agent model through the plugin LLM runtime
Generate standup	Cards for the selected day and previous day	Default agent model through the plugin LLM runtime
Ask your day	The question, selected-day cards, and recent observations	Default agent model through the plugin LLM runtime

구성

All Logbook config keys are optional. Numeric values are rounded to integers and clamped to the supported range.

Key	Default	Range or values	Behavior
`captureEnabled`	`true`	boolean	Persistent master switch for new snapshots; the timeline remains available when `false`
`captureIntervalSeconds`	`30`	`5`-`600`	Delay between capture attempts
`analysisIntervalMinutes`	`15`	`3`-`120`	Target observation window; gaps and midnight can close it earlier
`nodeId`	unset	node id or display name	Pins capture to one connected node; matching is case-insensitive
`screenIndex`	`0`	`0`-`16`	Zero-based display index
`maxWidth`	`1440`	`480`-`3840`	Requested capture size cap; headless macOS applies it to the largest dimension
`visionModel`	unset	`provider/model`	Explicit structured route; malformed refs pause analysis, unsupported providers fail batches
`retentionDays`	`14`	`1`-`365`	Deletes old frames; cards, observations, and standups remain

{
  plugins: {
    entries: {
      codex: {
        enabled: true,
      },
      logbook: {
        enabled: true,
        config: {
          captureEnabled: true,
          captureIntervalSeconds: 30,
          analysisIntervalMinutes: 15,
          nodeId: "my-mac",
          screenIndex: 0,
          maxWidth: 1440,
          visionModel: "codex/gpt-5.6-sol",
          retentionDays: 14,
        },
      },
    },
  },
}

Vision model selection

Logbook resolves the observation model in this order:

Dashboard tab

app, distraction chips, and a snapshot keyframe.

주요 항목:

Timeline: expandable cards per activity with category colors, the main
Day at a glance: focus ratio, category breakdown, top apps.
Daily standup: turns yesterday plus today into a ready-to-paste update.
Ask your day: natural-language questions answered from the tracked
Analyze now: closes the current capture window immediately instead of

Gateway methods

Logbook registers these Gateway RPC methods:

Method	Parameters	Scope	Result
`logbook.status`	none	`operator.read`	Capture, analysis, model, node, Gateway day, and Gateway timezone status
`logbook.days`	none	`operator.read`	Days with timeline-card counts and card time bounds
`logbook.timeline`	`{ day?: "YYYY-MM-DD" }`	`operator.read`	Derived cards and day statistics; defaults to the Gateway's current day
`logbook.frames`	`{ startMs, endMs }`	`operator.write`	Frame metadata in the requested epoch-millisecond range
`logbook.frame`	`{ frameId }`	`operator.write`	One raw JPEG frame as base64
`logbook.standup`	`{ day?, refresh? }`	`operator.write`	Cached or regenerated standup text for a day
`logbook.ask`	`{ day?, question }`	`operator.write`	Timeline-grounded answer for a day
`logbook.capture.set`	`{ paused }`	`operator.write`	Session-only pause state and updated status
`logbook.analyze.now`	none	`operator.write`	Starts pending analysis, or returns a reason it could not start

Privacy notes

leave the machine except as sampled input to the configured observation model.

주요 항목:

Snapshots can contain anything on screen, including secrets. Frames never
Observations, recent cards, and questions can leave the machine through the
Use local routes for both the structured observation model and default agent
Frames, the timeline database, and temporary captures are written with
Adding screen.snapshot to gateway.nodes.commands.deny is the
Setting tools.media.image.enabled: false also stops Logbook from borrowing

트러블슈팅

이 섹션의 세부 항목은 공식 문서 트러블슈팅를 참고하세요.

The Logbook tab is missing

openclaw plugins list --enabled includes logbook. 2. The Gateway restarted after the plugin or allowlist change. 3. The Control UI connection has operator.write; read-only sessions do not receive the interactive tab descriptor.

Capture reports an error

After three consecutive failures, Logbook backs off for ten capture ticks and then retries. An unpinned setup can rotate to another eligible node.

주요 항목:

Confirm the node exposes screen.snapshot or logbook.snapshot.
Grant Screen Recording permission on the capture Mac.
If nodeId is configured, confirm it matches the node id or display name.
Check that gateway.nodes.commands.deny does not contain

openclaw nodes status --connected
openclaw nodes describe --node <idOrNameOrIp>
openclaw logs --follow

Captures succeed but no cards appear

found. Enable and authenticate the Codex plugin, or set a valid explicit visionModel. Captured frames remain pending while the model is missing and can be analyzed after configuration is fixed.

주요 항목:

A Model missing status means no compatible structured vision route was
Wait for analysisIntervalMinutes, or select Analyze now after activity
Consecutive identical frames are idle evidence and do not enter analysis
If the latest batch shows an error, fix the model or auth problem and select

실습 체크리스트

공식 문서와 로컬 버전을 대조합니다: https://docs.openclaw.ai/plugins/logbook
관련 CLI는 openclaw --help 및 하위 명령 --help로 옵션을 확인합니다.
설정 변경 시 openclaw config / openclaw doctor로 유효성을 검사합니다.
Gateway·채널·플러그인 변경 후에는 필요 시 Gateway를 재시작합니다.

자주 쓰는 명령·설정 예시

openclaw plugins enable codex
openclaw plugins enable logbook

{
  plugins: {
    entries: {
      codex: {
        enabled: true,
      },
      logbook: {
        enabled: true,
        config: {
          visionModel: "codex/gpt-5.6-sol",
        },
      },
    },
  },
}

openclaw gateway restart
openclaw plugins inspect logbook --runtime --json
openclaw nodes status --connected
openclaw nodes describe --node <idOrNameOrIp>
openclaw dashboard

{
  plugins: {
    entries: {
      codex: {
        enabled: true,
      },
      logbook: {
        enabled: true,
        config: {
          captureEnabled: true,
          captureIntervalSeconds: 30,
          analysisIntervalMinutes: 15,
          nodeId: "my-mac",
          screenIndex: 0,
          maxWidth: 1440,
          visionModel: "codex/gpt-5.6-sol",
          retentionDays: 14,
        },
      },
    },
  },
}

openclaw nodes status --connected
openclaw nodes describe --node <idOrNameOrIp>
openclaw logs --follow

Logbook plugin

핵심 요약

문서 구성

상세 내용

본문

시작하기 전에

Quickstart

동작 방식

Model and data flow

구성

Vision model selection

Dashboard tab

Gateway methods

Privacy notes

트러블슈팅

The Logbook tab is missing

Capture reports an error

Captures succeed but no cards appear

관련 문서

실습 체크리스트

자주 쓰는 명령·설정 예시

관련 링크

관련 가이드

Logbook plugin

핵심 요약

문서 구성

상세 내용

본문

시작하기 전에

Quickstart

동작 방식

Model and data flow

구성

Vision model selection

Dashboard tab

Gateway methods

Privacy notes

트러블슈팅

The Logbook tab is missing

Capture reports an error

Captures succeed but no cards appear

관련 문서

실습 체크리스트

자주 쓰는 명령·설정 예시

관련 링크

관련 가이드