pinpatch
v0.1.4
Published
CLI for Pinpatch pin-to-code workflow with local proxy and overlay runtime.
Downloads
583
Maintainers
Readme
pinpatch
Pinpatch lets you place pins on a running local app, generate implementation tasks, and execute them through supported providers (codex or claude).
Install
Global install:
npm install -g pinpatch
pinpatch --helpRun without global install:
npx pinpatch@latest --helpPrerequisites
- Node.js
>=18 - A local web app running on
localhost(default target port3000) - For Codex execution:
codexCLI installed and authenticated - For Claude execution:
claudeCLI installed and authenticated
Quick Start
- Start your local app (example on
3000). - In another terminal,
cdinto your app's directory and start Pinpatch:
cd /path/to/your-app
pinpatch dev --target 3000- Open the proxied app at
http://localhost:3030. - Press
cto enter pin mode, click an element, and submit a request.
Commands
pinpatch --help
pinpatch dev --target 3000
pinpatch implement <taskId>
pinpatch tasks
pinpatch tasks --pruneRuntime Artifacts
Pinpatch writes runtime files to:
.pinpatch/
config.json
tasks/
sessions/
screenshots/
runtime/logs/Troubleshooting
Target localhost:<port> is unreachable: start your app first.Bridge port ... is already in use/Proxy port ... is already in use: choose different ports.- Provider process errors: verify
codex/claudeCLI authentication and PATH setup.
Monorepo Source
For contributor workflows and e2e testing, see the repository root docs in README.md and CONTRIBUTING.md.
