pyralph
0.1.0

User Guide:

  • Installation
    • Requirements
    • Install from PyPI
    • Install from Source
    • Verifying Installation
    • Next Steps
  • Quick Start
    • Starting the Agent
      • Auto-Accept Mode
      • Running Specific Phases
    • State Management
      • Hard Reset
      • Re-plan
      • Skip a Task
    • Debugging
    • Next Steps
  • Concepts
    • Three-Phase Workflow
    • Core Features
      • File-based State
      • Verification Gate
      • Retry Mechanism
      • Knowledge Injection
      • Hook System
      • CI/CD Support
    • How It Works
      • Data Flow
    • Knowledge Injection
    • Project Structure
      • Core Components
      • Agent Architecture
  • CLI Reference
    • Quick Reference
    • Output/Verbosity
    • Intent/Input
    • Architect Control
    • Execution Control
    • Context
    • Model/LLM
    • Logging/IO
    • Headless/CI
      • CI Mode
      • Status Check Exit Codes
      • JSON Output Format
    • Extensibility
    • Privacy
    • PRD Validation
    • Enhancement Features
      • Enhancement Flags Reference
      • Intent Enhancement
      • PRD Revision
      • Using --enhance-all
      • Combining Enhancement Flags with Other Options
      • Fallback Behavior
      • Error Messages and Resolutions
      • Events Emitted by Enhancement Features
    • Hook/Event System
      • Available Event Types
      • Event Payload
      • Creating Python Module Hooks
      • Creating Executable Hooks
      • Hook Execution Behavior
    • Plugin System
      • Loading Plugins
      • Creating a Plugin
      • Combining with Hooks for CI Notifications

Reference:

  • API Reference
    • Core Module
      • RalphOrchestrator
        • RalphOrchestrator.run_architect()
        • RalphOrchestrator.run_planner()
        • RalphOrchestrator.execute_loop()
        • RalphOrchestrator.start()
      • main()
      • get_version()
      • Config
        • Config.BASE_DIR
        • Config.ROOT_DIR
        • Config.ARCHIVE_DIR
        • Config.TEMPLATES_DIR
        • Config.HOOKS_DIR
        • Config.PRD_FILE
        • Config.PROGRESS_FILE
        • Config.LOG_FILE
        • Config.MAX_RETRIES
        • Config.TIMEOUT_SECONDS
        • Config.ensure_directories()
      • Logger
        • Logger.COLORS
        • Logger.no_color
        • Logger.quiet
        • Logger.no_emoji
        • Logger.LOG_LEVELS
        • Logger.log_level
        • Logger.json_output
        • Logger.ndjson_output
        • Logger.custom_log_file
        • Logger.non_interactive
        • Logger.redact_patterns
        • Logger.no_log_prompts
        • Logger.no_log_responses
        • Logger.set_no_color()
        • Logger.set_verbose()
        • Logger.set_verbosity()
        • Logger.set_quiet()
        • Logger.set_no_emoji()
        • Logger.set_log_level()
        • Logger.set_json_output()
        • Logger.set_ndjson_output()
        • Logger.set_log_file()
        • Logger.set_non_interactive()
        • Logger.set_redact_patterns()
        • Logger.add_redact_patterns_from_file()
        • Logger.set_no_log_prompts()
        • Logger.set_no_log_responses()
        • Logger.get_log_file()
        • Logger.info()
        • Logger.debug()
        • Logger.trace()
        • Logger.ultra()
        • Logger.warning()
        • Logger.error()
        • Logger.file_log()
      • Shell
        • Shell.run()
        • Shell.DEFAULT_TREE_IGNORE
        • Shell.get_file_tree()
      • PRDManager
        • PRDManager.exists()
        • PRDManager.invalidate_cache()
        • PRDManager.read_raw()
        • PRDManager.load()
        • PRDManager.save()
        • PRDManager.delete()
      • JsonUtils
        • JsonUtils.parse()
      • TemplateManager
        • TemplateManager.DEFAULT_TEMPLATES
        • TemplateManager.ensure_templates()
        • TemplateManager.load()
        • TemplateManager.render()
      • HookManager
        • HookManager.CONFIG_FILENAME
        • HookManager.enable()
        • HookManager.disable()
        • HookManager.set_enabled_hooks()
        • HookManager.is_enabled
        • HookManager.is_hook_enabled()
        • HookManager.register_hook()
        • HookManager.unregister_hook()
        • HookManager.clear_hooks()
        • HookManager.discover()
        • HookManager.emit()
        • HookManager.get_hooks_for_event()
        • HookManager.get_all_hooks()
      • Event
        • Event.event_type
        • Event.timestamp
        • Event.phase
        • Event.task_id
        • Event.task_description
        • Event.retry_count
        • Event.max_retries
        • Event.error
        • Event.verification_command
        • Event.verification_exit_code
        • Event.prd_path
        • Event.issue_number
        • Event.issue_title
        • Event.issue_url
        • Event.issues_count
        • Event.metadata
        • Event.to_dict()
        • Event.to_json()
      • EventType
        • EventType.PHASE_START
        • EventType.PHASE_END
        • EventType.ARCHITECT_START
        • EventType.ARCHITECT_SUCCESS
        • EventType.ARCHITECT_FAILURE
        • EventType.PLANNER_START
        • EventType.PLANNER_SUCCESS
        • EventType.PLANNER_FAILURE
        • EventType.EXECUTE_START
        • EventType.EXECUTE_END
        • EventType.TASK_START
        • EventType.TASK_SUCCESS
        • EventType.TASK_FAILURE
        • EventType.TASK_RETRY
        • EventType.VERIFICATION_START
        • EventType.VERIFICATION_SUCCESS
        • EventType.VERIFICATION_FAILURE
        • EventType.INTENT_ENHANCE_START
        • EventType.INTENT_ENHANCE_SUCCESS
        • EventType.INTENT_ENHANCE_FAILURE
        • EventType.PRD_CREATED
        • EventType.PRD_ARCHIVED
        • EventType.PRD_REVISE_START
        • EventType.PRD_REVISE_SUCCESS
        • EventType.PRD_REVISE_FAILURE
        • EventType.PRD_COMPLETE
        • EventType.PRD_INCOMPLETE
        • EventType.ERROR
        • EventType.WATCHER_START
        • EventType.WATCHER_STOP
        • EventType.ISSUE_DETECTED
        • EventType.ISSUE_STORED
        • EventType.ISSUE_QUEUED
        • EventType.ISSUE_PROCESSING_START
        • EventType.ISSUE_PROCESSING_SUCCESS
        • EventType.ISSUE_PROCESSING_FAILURE
        • EventType.POLL_START
        • EventType.POLL_SUCCESS
        • EventType.POLL_ERROR
      • Hook
        • Hook.execute()
      • PythonHook
        • PythonHook.execute()
      • ExecutableHook
        • ExecutableHook.execute()
      • FunctionHook
        • FunctionHook.execute()
      • BaseAgent
        • BaseAgent.set_logger()
        • BaseAgent.set_config()
        • BaseAgent.check_dependencies()
        • BaseAgent.get_name()
        • BaseAgent.run()
      • AgentError
        • AgentError.exception_type
        • AgentError.message
        • AgentError.stack_trace
        • AgentError.timestamp
        • AgentError.agent_name
        • AgentError.task_id
        • AgentError.format_log_entry()
        • AgentError.from_exception()
      • get_agent()
      • list_agents()
    • Orchestrator
      • RalphOrchestrator
        • RalphOrchestrator.run_architect()
        • RalphOrchestrator.run_planner()
        • RalphOrchestrator.execute_loop()
        • RalphOrchestrator.start()
    • Configuration
      • Config
        • Config.BASE_DIR
        • Config.ROOT_DIR
        • Config.ARCHIVE_DIR
        • Config.TEMPLATES_DIR
        • Config.HOOKS_DIR
        • Config.PRD_FILE
        • Config.PROGRESS_FILE
        • Config.LOG_FILE
        • Config.MAX_RETRIES
        • Config.TIMEOUT_SECONDS
        • Config.ensure_directories()
    • CLI
      • get_version()
      • main()
    • Logger
      • Logger
        • Logger.COLORS
        • Logger.no_color
        • Logger.quiet
        • Logger.no_emoji
        • Logger.LOG_LEVELS
        • Logger.log_level
        • Logger.json_output
        • Logger.ndjson_output
        • Logger.custom_log_file
        • Logger.non_interactive
        • Logger.redact_patterns
        • Logger.no_log_prompts
        • Logger.no_log_responses
        • Logger.set_no_color()
        • Logger.set_verbose()
        • Logger.set_verbosity()
        • Logger.set_quiet()
        • Logger.set_no_emoji()
        • Logger.set_log_level()
        • Logger.set_json_output()
        • Logger.set_ndjson_output()
        • Logger.set_log_file()
        • Logger.set_non_interactive()
        • Logger.set_redact_patterns()
        • Logger.add_redact_patterns_from_file()
        • Logger.set_no_log_prompts()
        • Logger.set_no_log_responses()
        • Logger.get_log_file()
        • Logger.info()
        • Logger.debug()
        • Logger.trace()
        • Logger.ultra()
        • Logger.warning()
        • Logger.error()
        • Logger.file_log()
    • Shell
      • Shell
        • Shell.run()
        • Shell.DEFAULT_TREE_IGNORE
        • Shell.get_file_tree()
    • PRD Manager
      • PRDManager
        • PRDManager.exists()
        • PRDManager.invalidate_cache()
        • PRDManager.read_raw()
        • PRDManager.load()
        • PRDManager.save()
        • PRDManager.delete()
      • JsonUtils
        • JsonUtils.parse()
    • Templates
      • PromptFormatter
        • PromptFormatter.DELIMITERS
        • PromptFormatter.wrap()
        • PromptFormatter.format_list()
        • PromptFormatter.format_code_block()
      • TemplateManager
        • TemplateManager.DEFAULT_TEMPLATES
        • TemplateManager.ensure_templates()
        • TemplateManager.load()
        • TemplateManager.render()
    • Hooks
      • EventType
        • EventType.PHASE_START
        • EventType.PHASE_END
        • EventType.ARCHITECT_START
        • EventType.ARCHITECT_SUCCESS
        • EventType.ARCHITECT_FAILURE
        • EventType.PLANNER_START
        • EventType.PLANNER_SUCCESS
        • EventType.PLANNER_FAILURE
        • EventType.EXECUTE_START
        • EventType.EXECUTE_END
        • EventType.TASK_START
        • EventType.TASK_SUCCESS
        • EventType.TASK_FAILURE
        • EventType.TASK_RETRY
        • EventType.VERIFICATION_START
        • EventType.VERIFICATION_SUCCESS
        • EventType.VERIFICATION_FAILURE
        • EventType.INTENT_ENHANCE_START
        • EventType.INTENT_ENHANCE_SUCCESS
        • EventType.INTENT_ENHANCE_FAILURE
        • EventType.PRD_CREATED
        • EventType.PRD_ARCHIVED
        • EventType.PRD_REVISE_START
        • EventType.PRD_REVISE_SUCCESS
        • EventType.PRD_REVISE_FAILURE
        • EventType.PRD_COMPLETE
        • EventType.PRD_INCOMPLETE
        • EventType.ERROR
        • EventType.WATCHER_START
        • EventType.WATCHER_STOP
        • EventType.ISSUE_DETECTED
        • EventType.ISSUE_STORED
        • EventType.ISSUE_QUEUED
        • EventType.ISSUE_PROCESSING_START
        • EventType.ISSUE_PROCESSING_SUCCESS
        • EventType.ISSUE_PROCESSING_FAILURE
        • EventType.POLL_START
        • EventType.POLL_SUCCESS
        • EventType.POLL_ERROR
      • Event
        • Event.event_type
        • Event.timestamp
        • Event.phase
        • Event.task_id
        • Event.task_description
        • Event.retry_count
        • Event.max_retries
        • Event.error
        • Event.verification_command
        • Event.verification_exit_code
        • Event.prd_path
        • Event.issue_number
        • Event.issue_title
        • Event.issue_url
        • Event.issues_count
        • Event.metadata
        • Event.to_dict()
        • Event.to_json()
      • Hook
        • Hook.execute()
      • PythonHook
        • PythonHook.execute()
      • ExecutableHook
        • ExecutableHook.execute()
      • FunctionHook
        • FunctionHook.execute()
      • HookManager
        • HookManager.CONFIG_FILENAME
        • HookManager.enable()
        • HookManager.disable()
        • HookManager.set_enabled_hooks()
        • HookManager.is_enabled
        • HookManager.is_hook_enabled()
        • HookManager.register_hook()
        • HookManager.unregister_hook()
        • HookManager.clear_hooks()
        • HookManager.discover()
        • HookManager.emit()
        • HookManager.get_hooks_for_event()
        • HookManager.get_all_hooks()
    • Agents
      • BaseAgent
        • BaseAgent.set_logger()
        • BaseAgent.set_config()
        • BaseAgent.check_dependencies()
        • BaseAgent.get_name()
        • BaseAgent.run()
      • AgentError
        • AgentError.exception_type
        • AgentError.message
        • AgentError.stack_trace
        • AgentError.timestamp
        • AgentError.agent_name
        • AgentError.task_id
        • AgentError.format_log_entry()
        • AgentError.from_exception()
      • ClaudeAgent
        • ClaudeAgent.get_name()
        • ClaudeAgent.check_dependencies()
      • get_agent()
      • list_agents()
      • Base Agent
        • AgentError
        • BaseAgent
      • Claude Agent
        • ClaudeAgent
      • GitHub Copilot Agent
        • GithubAgent
  • Architecture
    • Tech Stack
    • Overview
    • Architectural Patterns
    • Key Components
    • SOLID Principles Assessment
    • API Boundaries & Integration Points
      • External Integrations
      • Internal Interfaces
      • Data Formats
      • Protocols
    • Error Handling & Logging
      • Error Strategy
      • Logging Approach
      • Log Levels
    • Security Considerations
      • Authentication
      • Input Validation
      • Secrets Management
      • Potential Concerns
    • Testing Conventions
      • Layout
      • Naming
      • Shared Helpers
      • Multi-Feature Tests
      • Feedback and Updates

Project Info:

  • Changelog
    • [Unreleased]
      • Added
      • Changed
      • Deprecated
      • Removed
      • Fixed
      • Security
    • [0.1.0] - 24/01/2026
      • Added

Links:

  • GitHub Repository
pyralph
  • Overview: module code

All modules for which code is available

  • pyralph.agents
    • pyralph.agents.base
    • pyralph.agents.claude
    • pyralph.agents.copilot
  • pyralph.cli
  • pyralph.config
  • pyralph.hooks
  • pyralph.logger
  • pyralph.orchestrator
  • pyralph.prd
  • pyralph.shell
  • pyralph.templates

© Copyright 2024, Ralph Agent.

Built with Sphinx using a theme provided by Read the Docs.