High-performance browser automation bridge and multi-instance orchestrator with advanced stealth injection and real-time dashboard.
docs: cli redesign documentation for improved user experience
Mario66beb8754a3d
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex f445ea9b..f7b7ac83 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -5,6 +5,7 @@### Added- **PDF export parameters** — `/pdf` API now supports full PrintToPDFParams: `paperWidth`, `paperHeight`, `marginTop`, `marginBottom`, `marginLeft`, `marginRight`, `pageRanges`, `displayHeaderFooter`, `headerTemplate`, `footerTemplate`, `generateTaggedPDF`, `generateDocumentOutline`, `preferCSSPageSize` (#45, PR #48)- **Complete PDF CLI options** — `pinchtab pdf` command now supports all PDF export parameters matching the API functionality. Includes paper dimensions, margins, page ranges, headers/footers, and accessibility options (#54)+- **Simplified CLI usage** — New `pinchtab quick <url>` command combines navigation and page analysis. Added helpful error messages when server isn't running, smart suggestions after commands, and improved workflow documentation for beginners- **Installer branding** — install.sh now uses yellow accent color (#fbbf24) and crab icon 🦀 for consistency (PR #48)- **Ad blocking** — New `blockAds` option blocks 100+ tracking/analytics domains for cleaner snapshots. Available via env var `BRIDGE_BLOCK_ADS=true`, CLI flag `--block-ads`, and API parameter (#50)diff --git a/README.md b/README.mdindex dc88d8d0..169c96d0 100644--- a/README.md+++ b/README.md@@ -104,6 +104,21 @@ pinchtab --version## Quick Start+### CLI Quick Mode (NEW - Beginner Friendly)++```bash+# Install+npm install -g pinchtab++# One terminal:+pinchtab # Start server (keep running)++# Another terminal:+pinchtab quick https://example.com # Navigate + analyze page automatically+```++The `quick` command combines navigation and page analysis, showing you clickable elements and suggesting next actions.+### Docker (easiest)```bash@@ -343,18 +358,64 @@ In headed mode, log into sites in the visible Chrome window once; cookies and lo## CLI-The same `pinchtab` binary doubles as a CLI client. Start the server, then use subcommands:+The same `pinchtab` binary doubles as a CLI client with helpful guidance for beginners.++### Quick Start Workflow++```bash+# Terminal 1: Start server (keep running)+pinchtab++# Terminal 2: Use CLI commands+pinchtab quick https://example.com # NEW: Navigate + analyze in one command+```++### Guided Error Messages+If you forget to start the server:```bash+$ pinchtab snap+❌ Pinchtab server is not running on http://localhost:9867++To start the server:+ pinchtab # Run in foreground (recommended for beginners)+ pinchtab & # Run in background+ pinchtab --port 9868 # Use different port+```++### Smart Suggestions++After navigation, get helpful next steps:+```bash+$ pinchtab nav https://example.com++💡 Next steps:+ pinchtab snap # See page structure+ pinchtab screenshot # Capture visual+ pinchtab click <ref> # Click an element+ pinchtab pdf -o output.pdf # Save as PDF+```++### Full Command List++```bash+# Quick start+pinchtab quick <url> # Navigate + analyze page++# Navigation & interactionpinchtab nav https://httpbin.org/html # Navigatepinchtab snap -i -c # Snapshot (interactive, compact)pinchtab click e5 # Click element by refpinchtab type e12 hello world # Type into elementpinchtab press Enter # Press key++# Content extractionpinchtab text # Extract readable textpinchtab ss -o page.jpg # Screenshot+pinchtab pdf -o page.pdf --landscape # Export PDF (many options available)pinchtab eval "document.title" # Run JavaScript-pinchtab pdf -o page.pdf --landscape --page-ranges "1-3,5" # Export PDF with options++# Tab managementpinchtab tabs # List tabspinchtab tabs new https://httpbin.org # Open new tabpinchtab health # Check server