patchright-cli 0.3.1__py3-none-any.whl → 0.4.1__py3-none-any.whl

patchright_cli/__init__.py

@@ -1,3 +1,3 @@
 """patchright-cli — Undetected browser automation CLI using Patchright."""
 
-__version__ = "0.3.1"
+__version__ = "0.4.1"

patchright_cli/cli.py

@@ -11,6 +11,7 @@ import os
 import socket
 import struct
 import sys
+from pathlib import Path
 
 import click
 
@@ -18,6 +19,23 @@ from patchright_cli import __version__
 from patchright_cli.daemon import DEFAULT_PORT, ensure_daemon_running
 
 
+def _load_config(config_path: str | None) -> dict:
+    """Load JSON config file. If config_path is None, try .patchright-cli/config.json in cwd."""
+    p = Path(config_path) if config_path else Path.cwd() / ".patchright-cli" / "config.json"
+    if p.exists():
+        return json.loads(p.read_text(encoding="utf-8"))
+    return {}
+
+
+def _merge_config_with_options(config: dict, options: dict) -> dict:
+    """Merge config dict with CLI options. CLI options take precedence."""
+    merged = dict(config)
+    for k, v in options.items():
+        if v is not None:
+            merged[k] = v
+    return merged
+
+
 def _send_command(command: str, args: list, options: dict, port: int = DEFAULT_PORT) -> dict:
     """Connect to daemon, send command, receive response."""
     msg = {
@@ -61,6 +79,7 @@ def _recv_exact(sock: socket.socket, n: int) -> bytes:
 COMMANDS_HELP = {
     # Core
     "open": "open [url]           Open browser (starts daemon if needed)",
+    "attach": "attach --cdp=<url>   Attach to running Chrome via CDP",
     "goto": "goto <url>           Navigate to URL",
     "click": "click <ref> [button]  Click element [--modifiers=Alt,Shift]",
     "dblclick": "dblclick <ref> [btn] Double-click [--modifiers=Alt,Shift]",
@@ -70,8 +89,9 @@ COMMANDS_HELP = {
     "select": "select <ref> <value> Select dropdown option",
     "check": "check <ref>          Check checkbox/radio",
     "uncheck": "uncheck <ref>        Uncheck checkbox/radio",
-    "snapshot": "snapshot [ref]        Take accessibility snapshot",
-    "eval": "eval <expr>          Evaluate JavaScript [--file=F or stdin]",
+    "snapshot": "snapshot [ref]        Take accessibility snapshot [--filename=F] [--depth=N]",
+    "eval": "eval <expr> [ref]     Evaluate JavaScript [--file=F or stdin]",
+    "text": "text <ref|selector>  Get text content of element",
     "screenshot": "screenshot [ref]     Save screenshot [--full-page] [--filename=F]",
     "drag": "drag <from> <to>     Drag element to target",
     "close": "close                Close browser session",
@@ -79,6 +99,8 @@ COMMANDS_HELP = {
     "go-back": "go-back              Go back",
     "go-forward": "go-forward           Go forward",
     "reload": "reload               Reload page",
+    "url": "url                  Print current URL",
+    "title": "title                Print page title",
     # Keyboard
     "press": "press <key>          Press key",
     "keydown": "keydown <key>        Key down",
@@ -88,6 +110,11 @@ COMMANDS_HELP = {
     "mousedown": "mousedown [button]   Mouse button down",
     "mouseup": "mouseup [button]     Mouse button up",
     "mousewheel": "mousewheel <dx> <dy> Scroll mouse wheel",
+    # Scroll & Wait
+    "scroll": "scroll <dx> <dy>      Scroll by pixel offset",
+    "scroll-to": "scroll-to <ref>      Scroll element into view",
+    "wait": "wait <ms>            Wait for milliseconds",
+    "wait-for": "wait-for <ref>       Wait for element to appear [--state=hidden]",
     # Tabs
     "tab-list": "tab-list             List tabs",
     "tab-new": "tab-new [url]        Open new tab",
@@ -99,6 +126,8 @@ COMMANDS_HELP = {
     "cookie-set": "cookie-set <n> <v>   Set cookie [--domain --path --expires --httpOnly --secure --sameSite]",
     "cookie-delete": "cookie-delete <name> Delete cookie",
     "cookie-clear": "cookie-clear         Clear all cookies",
+    "cookie-import": "cookie-import <file> Import cookies from JSON",
+    "cookie-export": "cookie-export [file] Export cookies to JSON",
     "localstorage-list": "localstorage-list    List localStorage",
     "localstorage-get": "localstorage-get <k> Get localStorage item",
     "localstorage-set": "localstorage-set <k> <v>  Set localStorage item",
@@ -107,6 +136,8 @@ COMMANDS_HELP = {
     # Dialog
     "dialog-accept": "dialog-accept [text] Accept next dialog",
     "dialog-dismiss": "dialog-dismiss       Dismiss next dialog",
+    # Permissions
+    "grant-permissions": "grant-permissions <perms>  Grant permissions [--origin=url]",
     # Upload / Resize
     "upload": "upload <file> [ref]   Upload file to input",
     "resize": "resize <w> <h>        Resize viewport",
@@ -132,6 +163,7 @@ COMMANDS_HELP = {
     # Video
     "video-start": "video-start          Start video recording",
     "video-stop": "video-stop           Stop recording and save [--filename=F]",
+    "video-chapter": "video-chapter <title>  Add chapter marker to video",
     # PDF
     "pdf": "pdf [--filename=F]   Save page as PDF",
     # DevTools
@@ -142,6 +174,11 @@ COMMANDS_HELP = {
     "close-all": "close-all            Close all sessions",
     "kill-all": "kill-all             Kill all sessions",
     "delete-data": "delete-data          Delete persistent profile",
+    # Dashboard
+    "show": "show [--port=N]       Open session dashboard in browser",
+    # Codegen
+    "codegen": "codegen [file]        Start recording interactions",
+    "codegen-stop": "codegen-stop [file]   Stop recording and save script",
 }
 
 ALL_COMMANDS = list(COMMANDS_HELP.keys())
@@ -157,6 +194,18 @@ def _print_help():
     click.echo("  --proxy=<url>       Proxy server (e.g. http://host:port, socks5://host:port)")
     click.echo("  -s=<name>           Named session (default: 'default')")
     click.echo("  --port=<n>          Daemon port (default: 9321)")
+    click.echo("  --config=<path>     Load config from JSON file")
+    click.echo("  --timeout-action=ms   Default action timeout")
+    click.echo("  --timeout-navigation=ms Default navigation timeout")
+    click.echo("  --device=<name>     Emulate a device (e.g. 'iPhone 15')")
+    click.echo("  --viewport-size=WxH Set viewport size")
+    click.echo("  --locale=<code>     Locale (e.g. en-US)")
+    click.echo("  --timezone=<id>     Timezone ID")
+    click.echo("  --geolocation=lat,lon Geolocation override")
+    click.echo("  --user-agent=<ua>   Custom user agent")
+    click.echo("  --grant-permissions=P Comma-separated permissions to grant")
+    click.echo("  --cdp=<url>         Attach to Chrome via CDP endpoint")
+    click.echo("  --show-port=N       Dashboard port (default: 9322)")
     click.echo("  --version           Show version")
     click.echo("  --help              Show this help\n")
     click.echo("Commands:")
@@ -166,6 +215,7 @@ def _print_help():
             "Core",
             [
                 "open",
+                "attach",
                 "goto",
                 "click",
                 "dblclick",
@@ -177,14 +227,16 @@ def _print_help():
                 "uncheck",
                 "snapshot",
                 "eval",
+                "text",
                 "screenshot",
                 "drag",
                 "close",
             ],
         ),
-        ("Navigation", ["go-back", "go-forward", "reload"]),
+        ("Navigation", ["go-back", "go-forward", "reload", "url", "title"]),
         ("Keyboard", ["press", "keydown", "keyup"]),
         ("Mouse", ["mousemove", "mousedown", "mouseup", "mousewheel"]),
+        ("Scroll & Wait", ["scroll", "scroll-to", "wait", "wait-for"]),
         ("Tabs", ["tab-list", "tab-new", "tab-close", "tab-select"]),
         ("Dialog", ["dialog-accept", "dialog-dismiss"]),
         ("Upload/Resize", ["upload", "resize"]),
@@ -197,6 +249,8 @@ def _print_help():
                 "cookie-set",
                 "cookie-delete",
                 "cookie-clear",
+                "cookie-import",
+                "cookie-export",
                 "localstorage-list",
                 "localstorage-get",
                 "localstorage-set",
@@ -209,13 +263,16 @@ def _print_help():
                 "sessionstorage-clear",
             ],
         ),
+        ("Permissions", ["grant-permissions"]),
         ("Route", ["route", "route-list", "unroute", "network-state-set"]),
         ("Code", ["run-code"]),
         ("Tracing", ["tracing-start", "tracing-stop"]),
-        ("Video", ["video-start", "video-stop"]),
+        ("Video", ["video-start", "video-stop", "video-chapter"]),
         ("PDF", ["pdf"]),
         ("DevTools", ["console", "network"]),
         ("Session", ["list", "close-all", "kill-all", "delete-data"]),
+        ("Dashboard", ["show"]),
+        ("Codegen", ["codegen", "codegen-stop"]),
     ]
     for cat_name, cmds in categories:
         click.echo(f"\n  {cat_name}:")
@@ -233,8 +290,10 @@ def main():
     persistent = False
     profile = None
     proxy = None
-    session_name = "default"
+    config_path = None
+    session_name = os.environ.get("PATCHRIGHT_CLI_SESSION", "default")
     port = DEFAULT_PORT
+    extra_opts: dict = {}
 
     # Extract options
     remaining = []
@@ -273,6 +332,60 @@ def main():
             except ValueError:
                 click.echo(f"Invalid port value: {argv[i]}", err=True)
                 sys.exit(1)
+        elif arg.startswith("--config="):
+            config_path = arg.split("=", 1)[1]
+        elif arg == "--config" and i + 1 < len(argv):
+            i += 1
+            config_path = argv[i]
+        elif arg.startswith("--device="):
+            extra_opts["device"] = arg.split("=", 1)[1]
+        elif arg == "--device" and i + 1 < len(argv):
+            i += 1
+            extra_opts["device"] = argv[i]
+        elif arg.startswith("--viewport-size="):
+            vw, vh = arg.split("=", 1)[1].split("x", 1)
+            extra_opts["viewport"] = {"width": vw, "height": vh}
+        elif arg == "--viewport-size" and i + 1 < len(argv):
+            i += 1
+            vw, vh = argv[i].split("x", 1)
+            extra_opts["viewport"] = {"width": vw, "height": vh}
+        elif arg.startswith("--locale="):
+            extra_opts["locale"] = arg.split("=", 1)[1]
+        elif arg == "--locale" and i + 1 < len(argv):
+            i += 1
+            extra_opts["locale"] = argv[i]
+        elif arg.startswith("--timezone="):
+            extra_opts["timezone"] = arg.split("=", 1)[1]
+        elif arg == "--timezone" and i + 1 < len(argv):
+            i += 1
+            extra_opts["timezone"] = argv[i]
+        elif arg.startswith("--geolocation="):
+            lat, lon = arg.split("=", 1)[1].split(",", 1)
+            extra_opts["geolocation"] = {"lat": lat, "lon": lon}
+        elif arg == "--geolocation" and i + 1 < len(argv):
+            i += 1
+            lat, lon = argv[i].split(",", 1)
+            extra_opts["geolocation"] = {"lat": lat, "lon": lon}
+        elif arg.startswith("--user-agent="):
+            extra_opts["user-agent"] = arg.split("=", 1)[1]
+        elif arg == "--user-agent" and i + 1 < len(argv):
+            i += 1
+            extra_opts["user-agent"] = argv[i]
+        elif arg.startswith("--grant-permissions="):
+            extra_opts["grant-permissions"] = arg.split("=", 1)[1]
+        elif arg == "--grant-permissions" and i + 1 < len(argv):
+            i += 1
+            extra_opts["grant-permissions"] = argv[i]
+        elif arg.startswith("--cdp="):
+            extra_opts["cdp"] = arg.split("=", 1)[1]
+        elif arg == "--cdp" and i + 1 < len(argv):
+            i += 1
+            extra_opts["cdp"] = argv[i]
+        elif arg.startswith("--show-port="):
+            extra_opts["show-port"] = arg.split("=", 1)[1]
+        elif arg == "--show-port" and i + 1 < len(argv):
+            i += 1
+            extra_opts["show-port"] = argv[i]
         elif arg in ("--version", "-v"):
             click.echo(f"patchright-cli {__version__}")
             sys.exit(0)
@@ -297,16 +410,18 @@ def main():
 
     # Separate --key=value and --flag from positional args
     positional_args = []
-    extra_opts = {}
+    cmd_opts: dict = {}
     for a in args:
         if a.startswith("--") and "=" in a:
             k, v = a[2:].split("=", 1)
-            extra_opts[k] = v
+            cmd_opts[k] = v
         elif a.startswith("--"):
-            extra_opts[a[2:]] = True
+            cmd_opts[a[2:]] = True
         else:
             positional_args.append(a)
     args = positional_args
+    # Merge: global opts as base, command-level opts take precedence
+    extra_opts = {**extra_opts, **cmd_opts}
 
     # For eval/run-code: support --file=<path> and stdin via "-"
     if command in ("eval", "run-code"):
@@ -329,8 +444,9 @@ def main():
             click.echo(f"'{command}' requires a JS expression, --file=<path>, or piped stdin.", err=True)
             sys.exit(1)
 
-    # Build options dict
-    options = {"session": session_name, **extra_opts}
+    # Build options dict (config file values are overridden by explicit CLI flags)
+    config = _load_config(config_path)
+    options = {"session": session_name, **_merge_config_with_options(config, extra_opts)}
     if headless:
         options["headless"] = True
     if persistent:
@@ -340,26 +456,9 @@ def main():
     if proxy:
         options["proxy"] = proxy
 
-    # Ensure daemon is running (auto-start for 'open', require for others)
+    # Ensure daemon is running (auto-start for all commands)
     try:
-        if command == "open":
-            ensure_daemon_running(port, headless)
-        else:
-            # Try connecting first; if fails, tell user to open
-            import socket as _socket
-
-            sock = _socket.socket(_socket.AF_INET, _socket.SOCK_STREAM)
-            try:
-                sock.settimeout(1)
-                sock.connect(("127.0.0.1", port))
-            except (ConnectionRefusedError, OSError, TimeoutError):
-                click.echo(
-                    f"Daemon is not running on port {port}. Run 'patchright-cli open' first.",
-                    err=True,
-                )
-                sys.exit(1)
-            finally:
-                sock.close()
+        ensure_daemon_running(port, headless)
     except RuntimeError as e:
         click.echo(str(e), err=True)
         sys.exit(1)