ralph-py-cli 0.3.2__tar.gz

ralph_py_cli-0.3.2/.gitignore

@@ -0,0 +1,209 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+sandbox/

ralph_py_cli-0.3.2/CLAUDE.md

@@ -0,0 +1,66 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+ralph-py-cli is a CLI tool for running Claude Code iteratively. It provides two main commands:
+
+1. **`ralph run`** - Run Claude Code iteratively on a project
+   - Specify target folder and a plan (inline or from file)
+   - Set maximum number of iterations
+   - Execute Claude Code N times in sequence (a "Ralph loop")
+   - Interactive prompts between iterations to modify plan or continue
+   - Token usage tracking with tier-based rate limit percentages
+
+2. **`ralph plan`** - Improve a plan for optimal iterative execution
+   - Restructures plans into small, atomic steps
+   - Orders steps by dependencies
+   - Makes each step independently completable
+
+The core concept is automating repeated Claude Code runs against a codebase with a design document guiding each iteration.
+
+## Development Setup
+
+```bash
+# Install UV and Claude Code CLI
+./install.sh
+
+# Run tests
+uv run pytest tests/ -v
+
+# Run the CLI
+uv run ralph --help
+```
+
+## Tech Stack
+
+- **Language:** Python
+- **Package Manager:** UV (astral.sh/uv)
+- **CLI Framework:** Typer
+- **Output Formatting:** Rich
+
+## Project Structure
+
+```
+ralph-py-cli/
+├── src/ralph_py_cli/
+│   ├── cli.py              # Main CLI entry point (typer commands)
+│   └── utils/
+│       ├── claude_runner.py     # Claude Code subprocess execution
+│       ├── interactive.py       # Interactive prompts between iterations
+│       ├── ralph_plan_helper.py # Plan improvement logic
+│       └── token_usage.py       # Token tracking and tier percentages
+├── tests/
+│   ├── test_runner_integration.py  # Claude runner tests
+│   └── test_token_usage.py         # Token usage tests
+├── example_plans/          # Sample plan files
+├── pyproject.toml          # Project config and dependencies
+└── install.sh              # Setup script
+```
+
+## Key Concepts
+
+- **Iteration markers**: Claude Code outputs `<Improved>...</Improved>` when making progress or `<Completed>...</Completed>` when fully done
+- **Token tracking**: Tracks input/output tokens per iteration and shows usage against Pro, Max 5x, and Max 20x tier limits
+- **Interactive mode**: Between iterations, users can modify the plan, change iteration count, or skip future prompts

ralph_py_cli-0.3.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ryan Wiley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ralph_py_cli-0.3.2/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.4
+Name: ralph-py-cli
+Version: 0.3.2
+Summary: A CLI application for running Claude Code iteratively on design documents
+Project-URL: Homepage, https://github.com/rdubwiley09/ralph-py-cli
+Project-URL: Repository, https://github.com/rdubwiley09/ralph-py-cli
+Project-URL: Issues, https://github.com/rdubwiley09/ralph-py-cli/issues
+Author: Ryan Wiley
+License-Expression: MIT
+License-File: LICENSE
+Keywords: ai,automation,claude,cli,textual,tui
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: pandas>=2.3.3
+Requires-Dist: playwright>=1.57.0
+Requires-Dist: textual>=0.50.0
+Requires-Dist: typer>=0.12.0
+Description-Content-Type: text/markdown
+
+# ralph-py-cli
+
+## Note: this is a cli that allows one to run claude code in yolo mode for a given number of iterations. Use caution and other best practices when going degen mode.
+
+A CLI tool for running Claude Code iteratively on a project until completion.
+
+## What is a Ralph Loop?
+
+A Ralph loop automates repeated Claude Code runs against a codebase. Instead of running Claude Code once and manually re-running it to continue work, Ralph handles the iteration automatically.
+
+Each iteration:
+1. Sends your plan/design document to Claude Code
+2. Claude works on the task and reports progress
+3. If the task isn't complete, Ralph starts another iteration
+4. Continues until the task is done, an error occurs, or max iterations reached
+
+This is useful for larger tasks that require multiple Claude Code sessions to complete.
+
+## Installation
+
+```bash
+# Install via pip
+pip install ralph-py-cli
+
+# Or install via uv
+uv add ralph-py-cli
+```
+
+## Available Agents
+
+Ralph supports multiple AI coding agents:
+
+- **claude** (default) - Uses Claude Code CLI for code generation and iteration
+- **opencode** - Uses OpenCode CLI as an alternative agent (requires OpenCode to be installed)
+
+Both agents support the same Ralph loop workflow with iterative execution and interactive controls.
+
+### Agent-Specific Notes
+
+**OpenCode:**
+- Default model: `opencode/glm-4.7-free` (if no model is specified)
+- Requires OpenCode CLI to be installed and available in your PATH
+- Use `--model` to specify a different OpenCode model
+
+## CLI Usage
+
+Ralph provides two commands: `run` and `plan`.
+
+### Running the Loop
+
+```bash
+# Run with inline plan
+ralph run ./my-project --plan "Build a REST API with user authentication" --iterations 5
+
+# Run with plan from file
+ralph run ./my-project --plan-file design.md --iterations 10
+
+# With options
+ralph run ./my-project \
+  --plan-file design.md \
+  --iterations 10 \
+  --timeout 600 \
+  --model claude-sonnet-4-20250514 \
+  --verbose
+
+# Using OpenCode agent (alternative to Claude Code)
+ralph run ./my-project \
+  --plan-file design.md \
+  --iterations 10 \
+  --agent opencode
+
+# Using OpenCode with custom model
+ralph run ./my-project \
+  --plan "Build a REST API" \
+  --iterations 5 \
+  --agent opencode \
+  --model opencode/glm-4.7-free
+```
+
+**Options:**
+- `--plan, -p` - Plan text describing what to build
+- `--plan-file, -f` - Read plan from a file
+- `--iterations, -n` - Maximum iterations to run (required)
+- `--timeout, -t` - Timeout per iteration in seconds (default: 300)
+- `--agent, -a` - Agent to use: `claude` or `opencode` (default: claude)
+- `--model, -m` - Model override for the agent
+- `--verbose, -v` - Show detailed output
+- `--interactive/--no-interactive` - Enable/disable prompts between iterations (default: enabled)
+
+**Exit codes:**
+- `0` - Task completed successfully
+- `1` - Error occurred (timeout, process error, etc.)
+- `2` - Max iterations reached without completion
+
+### Improving a Plan
+
+The `plan` command restructures your plan into small, atomic steps optimized for iterative execution:
+
+```bash
+# Improve a plan from text
+ralph plan --plan "Build a web app with login, dashboard, and settings pages"
+
+# Improve a plan from file
+ralph plan --plan-file rough-ideas.md
+
+# Save improved plan to file
+ralph plan --plan-file rough-ideas.md --output optimized-plan.md
+```
+
+**Options:**
+- `--plan, -p` - Plan text to improve
+- `--plan-file, -f` - Read plan from a file
+- `--output, -o` - Write improved plan to file
+- `--timeout, -t` - Timeout in seconds (default: 120)
+- `--agent, -a` - Agent to use: `claude` or `opencode` (default: claude)
+- `--model, -m` - Model override for the agent
+- `--verbose, -v` - Show detailed output
+
+## Example Workflow
+
+1. Write a rough plan for what you want to build
+2. Use `ralph plan` to optimize it for iterative execution
+3. Use `ralph run` to execute the plan iteratively
+
+```bash
+# Start with a rough idea
+echo "Build a CLI todo app with add, list, and delete commands" > plan.txt
+
+# Optimize for iterative execution
+ralph plan --plan-file plan.txt --output optimized-plan.txt
+
+# Run the loop
+ralph run ./todo-project --plan-file optimized-plan.txt --iterations 5
+```
+
+## Interactive Loop Menu
+
+When running in an interactive terminal, Ralph pauses between iterations to let you control the loop. This gives you the opportunity to review progress and make adjustments.
+
+### Main Menu
+
+After each iteration, you'll see:
+
+```
+What would you like to do next?
+  [1] Continue to next iteration
+  [2] Edit loop settings
+  [3] Skip future prompts (auto-continue)
+  [4] Cancel
+```
+
+- **Continue** - Proceed to the next iteration with current settings
+- **Edit** - Open the edit menu to change plan or iterations
+- **Skip** - Disable prompts and auto-continue for remaining iterations
+- **Cancel** - Stop the loop immediately
+
+### Edit Menu
+
+When you select "Edit loop settings", you can make multiple changes before continuing:
+
+```
+=== Edit Loop Settings ===
+Current plan: <first 100 chars of plan>...
+Remaining iterations: X
+
+  [1] Change plan (enter text)
+  [2] Change plan (load from file)
+  [3] Change iteration count
+  [4] Confirm and continue
+  [5] Cancel (discard changes)
+```
+
+- **Change plan (text)** - Enter new plan text directly
+- **Change plan (file)** - Load plan from a file path
+- **Change iteration count** - Set remaining iterations
+- **Confirm** - Apply changes and continue to next iteration
+- **Cancel** - Discard all changes and return to main menu

ralph_py_cli-0.3.2/README.md

@@ -0,0 +1,177 @@
+# ralph-py-cli
+
+## Note: this is a cli that allows one to run claude code in yolo mode for a given number of iterations. Use caution and other best practices when going degen mode.
+
+A CLI tool for running Claude Code iteratively on a project until completion.
+
+## What is a Ralph Loop?
+
+A Ralph loop automates repeated Claude Code runs against a codebase. Instead of running Claude Code once and manually re-running it to continue work, Ralph handles the iteration automatically.
+
+Each iteration:
+1. Sends your plan/design document to Claude Code
+2. Claude works on the task and reports progress
+3. If the task isn't complete, Ralph starts another iteration
+4. Continues until the task is done, an error occurs, or max iterations reached
+
+This is useful for larger tasks that require multiple Claude Code sessions to complete.
+
+## Installation
+
+```bash
+# Install via pip
+pip install ralph-py-cli
+
+# Or install via uv
+uv add ralph-py-cli
+```
+
+## Available Agents
+
+Ralph supports multiple AI coding agents:
+
+- **claude** (default) - Uses Claude Code CLI for code generation and iteration
+- **opencode** - Uses OpenCode CLI as an alternative agent (requires OpenCode to be installed)
+
+Both agents support the same Ralph loop workflow with iterative execution and interactive controls.
+
+### Agent-Specific Notes
+
+**OpenCode:**
+- Default model: `opencode/glm-4.7-free` (if no model is specified)
+- Requires OpenCode CLI to be installed and available in your PATH
+- Use `--model` to specify a different OpenCode model
+
+## CLI Usage
+
+Ralph provides two commands: `run` and `plan`.
+
+### Running the Loop
+
+```bash
+# Run with inline plan
+ralph run ./my-project --plan "Build a REST API with user authentication" --iterations 5
+
+# Run with plan from file
+ralph run ./my-project --plan-file design.md --iterations 10
+
+# With options
+ralph run ./my-project \
+  --plan-file design.md \
+  --iterations 10 \
+  --timeout 600 \
+  --model claude-sonnet-4-20250514 \
+  --verbose
+
+# Using OpenCode agent (alternative to Claude Code)
+ralph run ./my-project \
+  --plan-file design.md \
+  --iterations 10 \
+  --agent opencode
+
+# Using OpenCode with custom model
+ralph run ./my-project \
+  --plan "Build a REST API" \
+  --iterations 5 \
+  --agent opencode \
+  --model opencode/glm-4.7-free
+```
+
+**Options:**
+- `--plan, -p` - Plan text describing what to build
+- `--plan-file, -f` - Read plan from a file
+- `--iterations, -n` - Maximum iterations to run (required)
+- `--timeout, -t` - Timeout per iteration in seconds (default: 300)
+- `--agent, -a` - Agent to use: `claude` or `opencode` (default: claude)
+- `--model, -m` - Model override for the agent
+- `--verbose, -v` - Show detailed output
+- `--interactive/--no-interactive` - Enable/disable prompts between iterations (default: enabled)
+
+**Exit codes:**
+- `0` - Task completed successfully
+- `1` - Error occurred (timeout, process error, etc.)
+- `2` - Max iterations reached without completion
+
+### Improving a Plan
+
+The `plan` command restructures your plan into small, atomic steps optimized for iterative execution:
+
+```bash
+# Improve a plan from text
+ralph plan --plan "Build a web app with login, dashboard, and settings pages"
+
+# Improve a plan from file
+ralph plan --plan-file rough-ideas.md
+
+# Save improved plan to file
+ralph plan --plan-file rough-ideas.md --output optimized-plan.md
+```
+
+**Options:**
+- `--plan, -p` - Plan text to improve
+- `--plan-file, -f` - Read plan from a file
+- `--output, -o` - Write improved plan to file
+- `--timeout, -t` - Timeout in seconds (default: 120)
+- `--agent, -a` - Agent to use: `claude` or `opencode` (default: claude)
+- `--model, -m` - Model override for the agent
+- `--verbose, -v` - Show detailed output
+
+## Example Workflow
+
+1. Write a rough plan for what you want to build
+2. Use `ralph plan` to optimize it for iterative execution
+3. Use `ralph run` to execute the plan iteratively
+
+```bash
+# Start with a rough idea
+echo "Build a CLI todo app with add, list, and delete commands" > plan.txt
+
+# Optimize for iterative execution
+ralph plan --plan-file plan.txt --output optimized-plan.txt
+
+# Run the loop
+ralph run ./todo-project --plan-file optimized-plan.txt --iterations 5
+```
+
+## Interactive Loop Menu
+
+When running in an interactive terminal, Ralph pauses between iterations to let you control the loop. This gives you the opportunity to review progress and make adjustments.
+
+### Main Menu
+
+After each iteration, you'll see:
+
+```
+What would you like to do next?
+  [1] Continue to next iteration
+  [2] Edit loop settings
+  [3] Skip future prompts (auto-continue)
+  [4] Cancel
+```
+
+- **Continue** - Proceed to the next iteration with current settings
+- **Edit** - Open the edit menu to change plan or iterations
+- **Skip** - Disable prompts and auto-continue for remaining iterations
+- **Cancel** - Stop the loop immediately
+
+### Edit Menu
+
+When you select "Edit loop settings", you can make multiple changes before continuing:
+
+```
+=== Edit Loop Settings ===
+Current plan: <first 100 chars of plan>...
+Remaining iterations: X
+
+  [1] Change plan (enter text)
+  [2] Change plan (load from file)
+  [3] Change iteration count
+  [4] Confirm and continue
+  [5] Cancel (discard changes)
+```
+
+- **Change plan (text)** - Enter new plan text directly
+- **Change plan (file)** - Load plan from a file path
+- **Change iteration count** - Set remaining iterations
+- **Confirm** - Apply changes and continue to next iteration
+- **Cancel** - Discard all changes and return to main menu

ralph_py_cli-0.3.2/example_plans/numbers.md

@@ -0,0 +1 @@
+If a file named numbers.txt doesn't exist create it. Then put one number between 1 and 5 in it. You are only allowed to put one number in at a time for each iteration. You will be complete when there are five numbers in this file

ralph_py_cli-0.3.2/example_plans/numbers_change.md

@@ -0,0 +1 @@
+If a file named numbers.txt doesn't exist create it. Then put one number between 5 and 10 in it. You are only allowed to put one number in at a time for each iteration. You will be complete when there are five numbers in this file

ralph_py_cli-0.3.2/install.sh

@@ -0,0 +1,3 @@
+curl -LsSf https://astral.sh/uv/install.sh | sh
+curl -fsSL https://claude.ai/install.sh | bash
+curl -fsSL https://opencode.ai/install | bash