Peekaboo AGENTS.md

Repository instructions for developing Peekaboo, a macOS automation project with command-line and desktop apps.

In plain words
What is it for?
Building and testing the CLI or macOS apps, working with shared Swift code, and updating the project's Git submodules correctly.
Why use it?
They explain where code belongs, how the connected modules work, and which commands and conventions to follow.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/openclaw/peekaboo/agents-md
Clone the repo
git clone --depth 1 https://github.com/openclaw/Peekaboo

Made for: Codex, OpenCode.

Per session 1,070 This file is loaded in full into every session.
When invoked 1,070 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.01070 $0.01070
Opus 5 $0.00535 $0.00535
Sonnet 5 $0.00214 $0.00214
Haiku 4.5 $0.00107 $0.00107

Measured 3d ago against content hash bc672c6ad5a4, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

Peekaboo AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 47 lines

How it starts

The opening of the file, as written. The whole thing — 47 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Repository Guidelines

Start Here

  • Read ~/Projects/agent-scripts/{AGENTS.MD,TOOLS.MD} before making changes (skip if missing).
  • This repo uses git submodules (AXorcist/, Commander/, Swiftdansi/, Tachikoma/, TauTUI/); update them in their home repos first, then bump pointers here.

Project Structure & Modules

  • Apps/CLI contains the SwiftPM package for the command-line tool; commands live under Apps/CLI/Sources, and unit/integration tests under Apps/CLI/Tests.
  • Apps/Mac, Apps/PeekabooInspector, and Apps/Playground host the macOS apps and related tooling; open Apps/Peekaboo.xcworkspace for Xcode work.
  • Shared logic sits in Core/PeekabooCore (automation, agent runtime, visualizer). Keep new utilities there rather than duplicating in apps.
  • Git submodules provide foundational pieces: AXorcist/ (AX automation), Commander/ (CLI parsing), Swiftdansi/ (ANSI parsing), Tachikoma/ (AI providers/MCP), and TauTUI/. Update them upstream first, then bump the pointers here.
  • Documentation lives in docs/; assets and marketing material are in assets/.

Build, Test, and Development Commands

  • Current local baseline is macOS 26.1 on arm64. If you’re on an older SDK/OS, expect menubar/accessibility flakiness; re-run with the 26 SDK before chasing Peekaboo regressions.
  • Run tools directly (runner removed). Use pnpm (Corepack-enabled).
  • Build the CLI: pnpm run build:cli (debug) or pnpm run build:swift:all (universal release). For arm64-only: pnpm run build:swift.
  • Rebuild the Mac app while editing Swift: ./scripts/build-mac-debug.sh.
  • Validate before handoff: pnpm run lint (SwiftLint), pnpm run format (SwiftFormat check/fix), then pnpm run test:safe. Full automation/UI tests: pnpm run test:automation or pnpm run test:all.
  • Tachikoma live provider checks: pnpm run tachikoma:test:integration.
  • You may run peekaboo CLI commands locally for repros/debugging; be mindful they capture the host desktop (screen recording/accessibility permissions required).

Read the full file on GitHub · 47 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 47 lines · 1,070 tokens per session scan A bc672c6ad5a4

Subscribe to this mod's changes

Peekaboo AGENTS.md is an instructions file published in the GitHub repository openclaw/Peekaboo (5,098 stars, last pushed 2d ago), licensed MIT. It adds 1,070 tokens to every session, about $0.0053 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

Applite CLAUDE.md

Instructions for milanvarady/Applite, covering claude.md, project overview, build & run, architecture and data flow.

milanvarady/Applite · 2,572 tokens

palmier-pro AGENTS.md

AGENTS.md instructions for palmier-io/palmier-pro, covering palmierpro, build, agents, engineering approach and code style.

palmier-io/palmier-pro · 6,680 tokens

scarf AGENTS.md

Instructions for awizemann/scarf: This repo carries its own agent memory — plain files in git, served by the in-repo memophant-mcp MCP server, managed by the Memophant macOS app. It works the same for every agent (Claude Code, Codex, Cursor, Gemini, Copilot). This block is regenerated between the memophant markers…

awizemann/scarf · 1,629 tokens

scarf copilot-instructions.md

Instructions for awizemann/scarf: File memory notes under one of six folders (architecture/conventions/decisions/operations/project/roadmap), never the root. When a note is grounded in code, pass sourcepaths (the repo files it depends on) so Memory Health can drift-check it — an unanchored code note can't be kept…

awizemann/scarf · 461 tokens

HomeClaw AGENTS.md

Instructions for omarshahine/HomeClaw, covering homeclaw, architecture, project structure, build system and xcode version.

omarshahine/HomeClaw · 10,044 tokens

liney AGENTS.md

Instructions for everettjf/liney, covering liney repository collaboration guide, 交流语言 / communication language, project overview, repository layout and build and test.

everettjf/liney · 1,589 tokens