Skip to main content

Documentation Index

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

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

​
planning

AI Agent Planning Module for PraisonAI Agents. Provides Planning Mode functionality similar to:
  • Cursor Plan Mode
  • Windsurf Planning Mode
  • Claude Code Plan Mode
  • Gemini CLI Plan Mode
  • Codex CLI /plan command
Features:
  • PlanningAgent for creating implementation plans
  • Plan and PlanStep dataclasses for plan structure
  • TodoList for tracking progress
  • PlanStorage for persistence
  • ApprovalCallback for plan approval flow
  • Read-only mode for safe research
Usage: from praisonaiagents import Agent, Task, AgentManager agents = AgentManager( agents=[agent1, agent2], tasks=[task1, task2], planning=True, # Enable planning mode planning_llm=“gpt-4o-mini” # Optional: custom LLM ) result = agents.start() This module uses lazy loading to minimize import time.

​
Import

from praisonaiagents import planning

​
Constants

NameValue
READ_ONLY_TOOLS['read_file', 'list_directory', 'search_codebase', 'search_files', 'grep_search', 'find_files', 'web_search', 'get_file_content', 'list_files', 'read_document', 'search_web', 'fetch_url', 'get_context...
RESTRICTED_TOOLS['write_file', 'create_file', 'delete_file', 'execute_command', 'run_command', 'shell_command', 'modify_file', 'edit_file', 'remove_file', 'move_file', 'copy_file', 'mkdir', 'rmdir', 'git_commit', 'gi...
RESEARCH_TOOLS['web_search', 'search_web', 'duckduckgo_search', 'tavily_search', 'brave_search', 'google_search', 'read_url', 'fetch_url', 'read_file', 'list_directory', 'search_codebase', 'grep_search', 'find_file...

Planning Concept

Planning Mode

Planning Configuration