Skip to content

Resolves #44: --help text for pdd commands - output rich documentation #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
qanagattandyr wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Resolves #44: --help text for pdd commands - output rich documentation #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3d0bed9
PR ready
qanagattandyr Nov 9, 2025
d1663a7
Merge branch 'promptdriven:main' into feature/pdd-run-command
qanagattandyr Nov 9, 2025
ad03a12
Merge branch 'promptdriven:main' into feature/pdd-run-command
qanagattandyr Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions pdd/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
from .track_cost import track_cost
from .update_main import update_main
from . import template_registry
from . import help_content


# --- Initialize Rich Console ---
Expand Down Expand Up @@ -642,7 +643,7 @@ def collect_usage_pieces(self, ctx: click.Context) -> List[str]:

# --- Command Definitions ---

@cli.command("generate", cls=GenerateCommand)
@cli.command("generate", cls=GenerateCommand, help=help_content.GENERATE_HELP)
@click.argument("prompt_file", required=False, type=click.Path(exists=True, dir_okay=False))
@click.option(
"--output",
Expand Down Expand Up @@ -737,7 +738,7 @@ def generate(
return None


@cli.command("example")
@cli.command("example", help=help_content.EXAMPLE_HELP)
@click.argument("prompt_file", type=click.Path(exists=True, dir_okay=False))
@click.argument("code_file", type=click.Path(exists=True, dir_okay=False))
@click.option(
Expand Down Expand Up @@ -768,7 +769,7 @@ def example(
return None


@cli.command("test")
@cli.command("test", help=help_content.TEST_HELP)
@click.argument("prompt_file", type=click.Path(exists=True, dir_okay=False))
@click.argument("code_file", type=click.Path(exists=True, dir_okay=False))
@click.option(
Expand Down Expand Up @@ -839,7 +840,7 @@ def test(
return None


@cli.command("preprocess")
@cli.command("preprocess", help=help_content.PREPROCESS_HELP)
@click.argument("prompt_file", type=click.Path(exists=True, dir_okay=False))
@click.option(
"--output",
Expand Down Expand Up @@ -909,7 +910,7 @@ def preprocess(
return None


@cli.command("fix")
@cli.command("fix", help=help_content.FIX_HELP)
@click.argument("prompt_file", type=click.Path(exists=True, dir_okay=False))
@click.argument("code_file", type=click.Path(exists=True, dir_okay=False))
@click.argument("unit_test_file", type=click.Path(exists=True, dir_okay=False))
Expand Down Expand Up @@ -1011,7 +1012,7 @@ def fix(
return None


@cli.command("split")
@cli.command("split", help=help_content.SPLIT_HELP)
@click.argument("input_prompt", type=click.Path(exists=True, dir_okay=False))
@click.argument("input_code", type=click.Path(exists=True, dir_okay=False))
@click.argument("example_code", type=click.Path(exists=True, dir_okay=False))
Expand Down Expand Up @@ -1055,7 +1056,7 @@ def split(
return None # Return None on failure


@cli.command("change")
@cli.command("change", help=help_content.CHANGE_HELP)
@click.argument("change_prompt_file", type=click.Path(exists=True, dir_okay=False))
@click.argument("input_code", type=click.Path(exists=True)) # Can be file or dir
@click.argument("input_prompt_file", type=click.Path(exists=True, dir_okay=False), required=False)
Expand Down Expand Up @@ -1125,7 +1126,7 @@ def change(
return None # Return None on failure


@cli.command("update")
@cli.command("update", help=help_content.UPDATE_HELP)
@click.argument("input_prompt_file", type=click.Path(exists=True, dir_okay=False))
@click.argument("modified_code_file", type=click.Path(exists=True, dir_okay=False))
@click.argument("input_code_file", type=click.Path(exists=True, dir_okay=False), required=False)
Expand Down Expand Up @@ -1243,7 +1244,7 @@ def conflicts(
return None # Return None on failure


@cli.command("crash")
@cli.command("crash", help=help_content.CRASH_HELP)
@click.argument("prompt_file", type=click.Path(exists=True, dir_okay=False))
@click.argument("code_file", type=click.Path(exists=True, dir_okay=False))
@click.argument("program_file", type=click.Path(exists=True, dir_okay=False))
Expand Down Expand Up @@ -1405,7 +1406,7 @@ def bug(
return None # Return None on failure


@cli.command("auto-deps")
@cli.command("auto-deps", help=help_content.AUTO_DEPS_HELP)
@click.argument("prompt_file", type=click.Path(exists=True, dir_okay=False))
@click.argument("directory_path", type=str) # Path with potential glob pattern
@click.option(
Expand Down Expand Up @@ -1465,7 +1466,7 @@ def auto_deps(
return None # Return None on failure


@cli.command("verify")
@cli.command("verify", help=help_content.VERIFY_HELP)
@click.argument("prompt_file", type=click.Path(exists=True, dir_okay=False))
@click.argument("code_file", type=click.Path(exists=True, dir_okay=False))
@click.argument("program_file", type=click.Path(exists=True, dir_okay=False))
Expand Down Expand Up @@ -1544,7 +1545,7 @@ def verify(
return None # Return None on failure


@cli.command("sync")
@cli.command("sync", help=help_content.SYNC_HELP)
@click.argument("basename", type=str)
@click.option(
"--max-attempts",
Expand Down
Loading