Skip to main content

Module plan_mode

Module plan_mode 

Source
Expand description

Plan mode tools for entering, exiting, and managing planning workflow

These tools allow the agent to programmatically enter and exit plan mode. The agent can:

  • Enter plan mode to switch to read-only exploration
  • Exit plan mode (triggering plan review) to start implementation
  • Persist canonical plans under .vtcode/plans/ by default (with optional custom path)

Based on insights from Claude Code’s plan mode implementation:

  • Plan files are written to a dedicated directory
  • The agent edits its own plan file during planning
  • Exiting plan mode reads the plan file and starts execution
  • User confirmation is required before transitioning to execution (HITL)

Structs§

EnterPlanModeArgs
Arguments for entering plan mode
EnterPlanModeTool
Tool for entering plan mode
ExitPlanModeArgs
Arguments for exiting plan mode
ExitPlanModeTool
Tool for exiting plan mode
PersistedPlanDraft
PlanModeState
Shared state for plan mode across tools
PlanValidationReport

Enums§

PlanLifecyclePhase

Functions§

generate_tracker_markdown_from_plan
merge_plan_content
persist_plan_draft
plan_file_for_tracker_file
sync_tracker_into_plan_file
tracker_file_for_plan_file
validate_plan_content