docs(peek-cli): document connect + sessions search; refresh whats-new + THREATMODEL header#149
Conversation
…s-new + THREATMODEL header - packages/peek-cli/README.md: add peek sessions search and peek connect (add/list/remove/start/stop/status/logs) to the Commands code block; add a "Connector daemon" subsection describing the supervised daemon architecture. - apps/peek-docs/src/pages/whats-new.astro: add sections 5-7 for search_sessions/verify_audit_log, peek connect daemon, and the Claude Code plugin (peekdev@peek) — all shipped but previously unlisted. - docs/peek/THREATMODEL.md: replace the stub header with an accurate "substantive" status noting the extension is CWS-live and residual gaps are accepted pre-1.0 scope. - .changeset/peek-cli-readme-connect-search.md: patch changeset for the README documentation update. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: harry-harish <22562634+harry-harish@users.noreply.github.com>
|
@coderabbitai review |
|
Warning Review limit reached
Next review available in: 34 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughThis PR is documentation-only: it adds a changeset for ChangesDocumentation Updates
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Action performedReview finished.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/peek/THREATMODEL.md (1)
48-49: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winRemove the leftover stub wording.
"To be expanded inline once the real threat model is written"still reads like an unfinished draft and clashes with the newsubstantivestatus in the header. Drop or rewrite it so the file reflects its current state.♻️ Minimal cleanup
-Reference Phase 4a/c artifacts and ADRs. To be expanded inline once the real threat model is written. +Reference Phase 4a/c artifacts and ADRs.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/peek/THREATMODEL.md` around lines 48 - 49, Remove the leftover draft/stub sentence in the THREATMODEL content and replace it with wording that matches the current substantive state. Update the referenced threat model section so it no longer says “To be expanded inline once the real threat model is written,” and make the text align with the existing Phase 4a/c artifacts and ADR references.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@apps/peek-docs/src/pages/whats-new.astro`:
- Around line 168-170: The CLI docs are missing the implemented peek audit
bundle subcommand, leaving the documented command list out of sync with the
router and release note. Update the command list in whats-new.astro to include
peek audit bundle alongside the existing audit commands, matching the
implemented surface in the audit CLI so the docs reflect log, verify, and bundle
consistently.
---
Outside diff comments:
In `@docs/peek/THREATMODEL.md`:
- Around line 48-49: Remove the leftover draft/stub sentence in the THREATMODEL
content and replace it with wording that matches the current substantive state.
Update the referenced threat model section so it no longer says “To be expanded
inline once the real threat model is written,” and make the text align with the
existing Phase 4a/c artifacts and ADR references.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 0e46d258-3730-485e-8ab9-b39051492e8f
📒 Files selected for processing (4)
.changeset/peek-cli-readme-connect-search.mdapps/peek-docs/src/pages/whats-new.astrodocs/peek/THREATMODEL.mdpackages/peek-cli/README.md
CodeRabbit flagged the audit command list as out of sync: it showed only `log` and `verify` and omitted the shipped `peek audit bundle` subcommand. - Add `peek audit bundle [--dir <path>] [--out <file>]` to the Commands block. - Update `peek audit verify` to show its real flags (`--dir`, `--bundle`, `--json`) in both the Commands block and the Audit-log-integrity prose. - Add a parallel prose sentence describing `peek audit bundle` and how a recipient verifies a received *.peekaudit archive. Flags sourced verbatim from packages/peek-cli/src/commands/audit.ts USAGE and audit-bundle.ts. Docs-only; changeset unchanged (@peekdev/cli patch). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: harry-harish <22562634+harry-harish@users.noreply.github.com>
|
@coderabbitai review |
✅ Action performedReview finished.
|
|
@coderabbitai full review |
✅ Action performedFull review finished. Your plan includes PR reviews subject to rate limits. More reviews will be available in 34 minutes. |
1 participant
Summary
Pre-release doc fix so the next npm alpha ships with correct docs. Three edits:
packages/peek-cli/README.md— addspeek sessions search(all flags:--q,--origin,--since,--until,--status,--errors,--limit,--json) and the fullpeek connectsubcommand surface (add <surface> [--name] [--command] [--args=<a>],list,remove,start,stop,status [name],logs [name] [--follow] [--lines N]) to the Commands code block. Also adds a### Connector daemonsubsection explaining the supervised-daemon architecture (registry in~/.peek/connect/connectors.json, detached supervisor, per-connector log files).apps/peek-docs/src/pages/whats-new.astro— adds three new sections (5, 6, 7) for shipped-but-unlisted items:search_sessions/verify_audit_logCLI + MCP tools, thepeek connectsupervised connector daemon (Slack surface), and the Claude Code plugin (peekdev@peek). Consistent with the existing entry format; no version numbers invented.docs/peek/THREATMODEL.md— replaces the stale "stub / to be filled in before CWS submission" header with an accurate "substantive" status. The body already covers all eight attack surfaces with mitigations; the header was the only stale part. Residual gaps (content-script isolation, fuzz coverage, CWS 2FA recovery, CDP UX wording, schema versioning) are noted as accepted pre-1.0 scope.Changeset:
.changeset/peek-cli-readme-connect-search.md—@peekdev/clipatch, since the README is in a published package. Thewhats-new.astroandTHREATMODEL.mdare app/docs files with no changeset needed.Build/lint:
pnpm build(all 16 packages + both Astro docs sites) andpnpm lint(biome, 588 files) both pass clean.🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
Documentation