Peekaboo/docs
2026-05-31 16:24:09 -04:00
..
archive/refactor refactor(cli): remove stale observation shims 2026-05-07 10:18:22 +01:00
commands feat(cli): use background keyboard delivery by default 2026-05-31 16:24:09 -04:00
debug chore(docs): consolidate docs 2025-11-25 18:08:05 +01:00
dev feat(cli): add completions 2026-05-05 06:38:24 +01:00
integrations docs: add subprocess integration guide 2026-05-05 06:55:59 +01:00
logging-profiles docs: raise minimum macOS to 15 2025-11-25 18:30:12 +01:00
providers feat(agent): add MiniMax China provider support (#162) 2026-05-25 11:05:05 +01:00
refactor refactor(cli): split runtime and MCP catalog seams 2026-05-10 17:48:54 +01:00
references chore(docs): move external references 2025-11-25 18:17:25 +01:00
reports fix(release): prepare 3.1.1 fallout release 2026-05-11 05:43:09 +01:00
research feat(agent): refresh supported model catalog 2026-05-10 14:44:02 +01:00
static docs: generate llms index from docs pages 2026-05-10 00:42:44 +01:00
testing feat(cli): use background keyboard delivery by default 2026-05-31 16:24:09 -04:00
agent-chat.md feat(cli): allow Esc to cancel chat turns 2025-11-14 14:34:54 +00:00
agent-patterns.md docs(metadata): refresh summaries and remove legacy specs 2025-11-14 04:46:12 +00:00
agent-skill.md docs: add Peekaboo CLI agent skill 2026-05-05 07:31:31 +01:00
AppKit-Implementing-Liquid-Glass-Design.md docs(metadata): refresh summaries and remove legacy specs 2025-11-14 04:46:12 +00:00
application-resolving.md docs: publish generated site at root 2026-05-09 11:31:49 +01:00
ARCHITECTURE.md docs: soften platform and provider reference language 2026-05-17 09:28:07 +01:00
audio.md fix(run): expand home-directory file paths 2026-05-07 19:13:36 +01:00
automation.md feat(cli): use background keyboard delivery by default 2026-05-31 16:24:09 -04:00
bridge-host.md feat: add daemon-backed fast capture and model refresh 2026-05-10 09:46:55 +01:00
browser-mcp.md refactor(cli): split runtime and MCP catalog seams 2026-05-10 17:48:54 +01:00
building.md docs: correct source build toolchain guidance 2026-05-17 09:28:07 +01:00
claude-hooks.md refactor: remove runner wrapper 2026-01-04 04:42:30 +01:00
cli-command-reference.md feat(cli): add completions 2026-05-05 06:38:24 +01:00
clipboard.md Fix CLI help usage and standardize JSON flag 2026-03-13 03:47:30 +00:00
commander.md refactor: remove runner wrapper 2026-01-04 04:42:30 +01:00
configuration.md feat(agent): add MiniMax China provider support (#162) 2026-05-25 11:05:05 +01:00
daemon.md refactor(cli): split runtime and MCP catalog seams 2026-05-10 17:48:54 +01:00
engine.md fix: update capture command references 2026-05-28 18:46:53 +01:00
error-handling-guide.md Fix CLI help usage and standardize JSON flag 2026-03-13 03:47:30 +00:00
focus.md feat(cli): use background keyboard delivery by default 2026-05-31 16:24:09 -04:00
homebrew-setup.md chore(release): arm64-only distribution 2025-12-19 18:30:10 +01:00
human-mouse-move.md feat(gestures): add human profile to drag & swipe 2025-11-14 06:26:35 +00:00
human-typing.md feat(typing): sync cadence with visualizer 2025-11-14 06:43:27 +00:00
index.md docs: clarify platform support guarantees 2026-05-17 09:28:07 +01:00
install.md docs: correct source build toolchain guidance 2026-05-17 09:28:07 +01:00
logging-guide.md Fix CLI help usage and standardize JSON flag 2026-03-13 03:47:30 +00:00
manual-testing.md docs: fix skill frontmatter and MCP capture docs 2026-05-28 16:04:37 +01:00
mcp-testing.md refactor(mcp): share observation target parsing 2026-05-07 12:32:49 +01:00
MCP.md feat(agent): refresh supported model catalog 2026-05-10 14:44:02 +01:00
modern-api.md feat(agent): refresh supported model catalog 2026-05-10 14:44:02 +01:00
modern-swift.md docs(metadata): refresh summaries and remove legacy specs 2025-11-14 04:46:12 +00:00
module-architecture-refactoring.md docs(metadata): refresh summaries and remove legacy specs 2025-11-14 04:46:12 +00:00
module-refactoring-example.md docs(metadata): refresh summaries and remove legacy specs 2025-11-14 04:46:12 +00:00
oauth.md fix(openai): use oauth for responses auth 2026-05-04 09:49:15 +01:00
permissions.md feat(cli): use background keyboard delivery by default 2026-05-31 16:24:09 -04:00
platform-support.md docs: correct source build toolchain guidance 2026-05-17 09:28:07 +01:00
playground-testing.md docs: rename automation sessions to snapshots 2025-12-13 06:12:42 +00:00
poltergeist.md chore(docs): consolidate poltergeist guidance 2025-11-25 18:16:50 +01:00
provider.md fix(config): preserve custom provider credential references 2026-05-17 11:08:52 +01:00
providers.md feat(agent): add MiniMax China provider support (#162) 2026-05-25 11:05:05 +01:00
quickstart.md feat(cli): use background keyboard delivery by default 2026-05-31 16:24:09 -04:00
README.md docs: soften platform and provider reference language 2026-05-17 09:28:07 +01:00
refactor.md refactor(cli): remove stale observation shims 2026-05-07 10:18:22 +01:00
RELEASING.md build: reuse shared mac release tooling 2026-05-21 22:00:27 +01:00
remote-testing.md test(automation): gate input synthesis tests 2026-05-08 08:44:31 +01:00
restore.md refactor(cli): remove stale observation shims 2026-05-07 10:18:22 +01:00
security.md feat(cli): use background keyboard delivery by default 2026-05-31 16:24:09 -04:00
service-api-reference.md docs: rename automation sessions to snapshots 2025-12-13 06:12:42 +00:00
silgen-crash-debug.md refactor: remove runner wrapper 2026-01-04 04:42:30 +01:00
skylight-spaces-api.md docs(metadata): refresh summaries and remove legacy specs 2025-11-14 04:46:12 +00:00
spec.md feat(agent): refresh supported model catalog 2026-05-10 14:44:02 +01:00
swift6-migration-compact.md docs(metadata): refresh summaries and remove legacy specs 2025-11-14 04:46:12 +00:00
swift-6.2-compiler-crash.md docs(metadata): refresh summaries and remove legacy specs 2025-11-14 04:46:12 +00:00
swift-module-plan.md docs(metadata): refresh summaries and remove legacy specs 2025-11-14 04:46:12 +00:00
swift-performance.md docs(metadata): refresh summaries and remove legacy specs 2025-11-14 04:46:12 +00:00
swift-subprocess.md docs(mcp): refresh server docs 2025-12-19 02:35:28 +00:00
swift-testing-playbook.md test: adopt any Error existential syntax 2025-11-08 03:51:28 +00:00
SwiftUI-Implementing-Liquid-Glass-Design.md docs(metadata): refresh summaries and remove legacy specs 2025-11-14 04:46:12 +00:00
SwiftUI-New-Toolbar-Features.md docs(metadata): refresh summaries and remove legacy specs 2025-11-14 04:46:12 +00:00
test-refactor.md test(automation): gate input synthesis tests 2026-05-08 08:44:31 +01:00
TODO.md ci: fix docs lint 2025-12-02 16:11:02 +00:00
tool-formatter-architecture.md docs(metadata): refresh summaries and remove legacy specs 2025-11-14 04:46:12 +00:00
tui.md chore(release): prepare 3.1.1 2026-05-11 05:24:50 +01:00
visualizer.md docs: raise minimum macOS to 15 2025-11-25 18:30:12 +01:00
window-screenshot-smart-select.md feat(window): enforce smart selection 2025-11-14 21:17:57 +00:00

summary read_when
Peekaboo documentation map
finding the right Peekaboo doc quickly
onboarding or sharing docs with teammates

Documentation map

  • Commandscommands/README.md plus one page per CLI command.
  • Providersproviders.md for the central provider list; providers/README.md for deep links.
  • Architecture & specsARCHITECTURE.md, spec.md, module-architecture-refactoring.md, service-api-reference.md.
  • Testing & QAtesting/ plans and manual guides, reports/ results.
  • Referencesreferences/ for external API reference excerpts (e.g., Swift toolchain/testing).
  • Research & design notesresearch/ deep dives and spike notes.
  • Refactorsrefactor.md points to the active plan; older migration logs live in archive/refactor/.
  • Release & opsplatform-support.md, RELEASING.md, building.md, permissions.md, security.md.

Use pnpm run docs:list for a searchable summary of all docs.