peekable
v0.1.4
Published
Share HTML mockups with collaborators — CLI for peekable-server
Readme
Peekable CLI
Share local HTML mockups, HTML response snapshots, and localhost apps with collaborators. Reviewers annotate the page in the browser; you pull structured feedback back into your terminal.
Install
npm install -g peekableFirst Run
peekable register --name "Your Name" --email "[email protected]" --invite-code "your-invite-code"
peekable init
peekable create "My first review"peekable create prints a session ID and share URL. Use the session ID with one
of the publish commands below.
Pick The Right Publish Command
Use push for a complete standalone HTML file:
peekable push <session-id> ./out.htmlUse push-url when a running page returns a mostly self-contained HTML response
you want to capture:
peekable push-url <session-id> http://localhost:3000Use proxy for a live localhost app with routes, assets, and interactivity:
peekable proxy 3000 --name "Homepage review"Pull Feedback
peekable feedback <session-id>
peekable watch <session-id>
peekable resolve <session-id> <annotation-id>Free Early Access Limits
The hosted free early-access tier allows 3 active sessions per user. Close old sessions when you are done:
peekable list
peekable close <session-id>Viewer connections are capped on the hosted service so early access stays reliable for everyone.
push-url snapshots localhost by default. To upload HTML fetched from a remote
URL, pass --allow-remote --yes; for private-network URLs, also pass
--allow-private.
Debug Setup
If something feels off, run:
peekable doctor
peekable doctor --jsonFor a deeper connectivity check that creates, pushes, and closes a temporary session:
peekable doctor --test-pushThe doctor output intentionally avoids HTML payloads, annotation text, and API keys so it is safe to paste into a support thread.
Remove Local Setup
To remove Peekable from your machine:
peekable uninstall
npm uninstall -g peekablepeekable uninstall removes local config at ~/.peekable and installed agent
skills at ~/.claude/skills/peekable and ~/.codex/skills/peekable. It does
not delete hosted sessions or account data.
