feat: add list-configs subcommand to CLI#31
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a list-configs Typer subcommand that prints the names of all built-in .yaml config files in webwright/config/, so users can discover available configs without browsing the source tree. The README flags table is updated to document the new command.
Changes:
- New
list_configs()Typer command insrc/webwright/run/cli.pythat globsbuiltin_config_dir/*.yamland prints filenames via the existingrichconsole. - Imports
builtin_config_dirfromwebwright.config. - README flags table renamed to "Flag / Command" and a
list-configsrow added.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/webwright/run/cli.py |
Registers a second Typer command (list-configs) and imports builtin_config_dir. |
README.md |
Documents list-configs in the flags table and renames the column header. |
Note: Registering a second @app.command() makes Typer require a subcommand, which breaks the existing no-subcommand invocation form documented in the README Quick Start and src/webwright/run/run_command.sh. This contradicts the PR description's claim that the main command is "not touched". See inline comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @app.command("list-configs") | ||
| def list_configs() -> None: | ||
| """List all available built-in config files.""" | ||
| configs = sorted(builtin_config_dir.glob("*.yaml")) | ||
| if not configs: | ||
| console.print("No config files found.") | ||
| return | ||
| for path in configs: | ||
| console.print(path.name) |
| | Flag / Command | Description | | ||
| |----------------|-------------| | ||
| | `-c` | Config file(s) from `src/webwright/config/` (stackable). | | ||
| | `-t` | Task instruction. | | ||
| | `--start-url` | Initial page. | | ||
| | `--task-id` | Output subfolder name. | | ||
| | `-o` | Output directory. | | ||
| | `list-configs` | Print all available built-in config file names (`python -m webwright.run.cli list-configs`). | |
|
Fixed in fda3bcd. Converted Changed |
New users have no way to discover which config files are available without browsing the source tree. Add `python -m webwright.run.cli list-configs` that prints all .yaml filenames from the built-in config directory. Update the README flags table to document the new command.
…tion Registering a second @app.command() forced Typer to require an explicit subcommand, breaking the existing `python -m webwright.run.cli -t "..."` invocation form. Switch `main` to @app.callback(invoke_without_command=True) so the default invocation works without a subcommand while list-configs remains available as an explicit subcommand. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
nuthalapativarun
force-pushed
the
feat/list-configs-cli
branch
from
fda3bcd to
89276cb
Compare
Problem
New users have no way to discover which config files are available without browsing the source tree. The
-cflag requires knowing a config filename in advance, creating friction for first-time users trying to switch backends (e.g. from OpenAI to Anthropic).Fix
Add a
list-configssubcommand to the Typer app that prints the names of all.yamlfiles in the built-in config directory. Update the README flags table to document the new command.Changes
src/webwright/run/cli.py— addedlist_configs()command decorated with@app.command("list-configs"); importsbuiltin_config_dirfromwebwright.configREADME.md— addedlist-configsrow to the flags table with usage exampleNot affected
maincommand — not touched; no flags changedwebwright/config/__init__.py—builtin_config_dirwas already exported; no changes needed